nimare.transforms
.ImageTransformer
- class ImageTransformer(target, overwrite=False)[source]
Bases:
nimare.base.Transformer
A class to create new images from existing ones within a Dataset.
This class is a light wrapper around
nimare.transforms.transform_images()
.New in version 0.0.9.
- Parameters
target ({‘z’, ‘p’, ‘beta’, ‘varcope’} or list) – Target image type. Multiple target types may be specified as a list.
overwrite (
bool
, optional) – Whether to overwrite existing files or not. Default is False.
See also
nimare.transforms.transform_images
The function called by this class.
- set_params(**params)[source]
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form
<component>__<parameter>
so that it’s possible to update each component of a nested object.- Returns
self
- transform(dataset)[source]
Generate images of the target type from other image types in a Dataset.
- Parameters
dataset (
nimare.dataset.Dataset
) – A Dataset containing images and relevant metadata.- Returns
new_dataset (
nimare.dataset.Dataset
) – A copy of the input Dataset, with new images added to its images attribute.