fluidimage.topologies.image2image#

Topology for image2image preprocessing#

class fluidimage.topologies.image2image.TopologyImage2Image(params, logging_level='info', nb_max_workers=None)[source]#

Bases: TopologyBaseFromImages

Topology for images processing with a user-defined function

The most useful methods for the user (in particular compute()) are defined in the base class fluidimage.topologies.base.TopologyBase.

Parameters:
paramsNone

A ParamContainer (created with the class method create_default_params()) containing the parameters for the computation.

logging_levelstr, {‘warning’, ‘info’, ‘debug’, …}

Logging level.

nb_max_workersNone, int

Maximum numbers of “workers”. If None, a number is computed from the number of cores detected. If there are memory errors, you can try to decrease the number of workers.

Splitter#

alias of SplitterFromImages

classmethod create_default_params()[source]#

Class method returning the default parameters.

Typical usage:

params = TopologyImage2Image.create_default_params()
# modify parameters here
...

topo = TopologyImage2Image(params)
save_image(tuple_path_image)[source]#

Save an image

Documentation for params#

  • im2im : str {None}

    Function or class to be used to process the images.

  • args_init : object {None}

    An argument given to the init function of the class used to process the images.

Documentation for params.saving#

Saving of the results.

  • path : None or str

    Path of the directory where the data will be saved. If None, the path is obtained from the input path and the parameter postfix.

  • how : str {‘ask’}

    ‘ask’, ‘new_dir’, ‘complete’ or ‘recompute’.

  • postfix : str

    Postfix from which the output file is computed.

Documentation for params.images#

Parameters indicating the input image set.

  • path : str, {‘’}

    String indicating the input images (can be a full path towards an image file or a string given to glob).

  • str_subset : None

    String indicating as a Python slicing how to select images from the serie of images on the disk. If None, no selection so all images will be processed.

Classes

Topology

alias of TopologyImage2Image

TopologyImage2Image(params[, logging_level, ...])

Topology for images processing with a user-defined function