nxtomomill.io.framegroup.FrameGroup#

class nxtomomill.io.framegroup.FrameGroup(url: ~typing.Optional[~typing.Union[~silx.io.url.DataUrl, str]], frame_type: [<enum 'AcquisitionStep'>, <class 'str'>], copy: ~typing.Optional[bool] = None)[source]#

Bases: object

class used to store information regarding a group of frame

contains the frames type and if we should provide a copy of those in the outputfile or not

Parameters:

url (None, str, DataUrl. If provided as a string should fit a DataUrl or be the data path on the input file) – url to access the frame group (bliss scan entry)
frame_type – frame type (dark, projection …)
copy (bool, None. If set to None then the value will be set to the default copy behavior during processing) – should we copy the dataframe in the output file

__init__(url: ~typing.Optional[~typing.Union[~silx.io.url.DataUrl, str]], frame_type: [<enum 'AcquisitionStep'>, <class 'str'>], copy: ~typing.Optional[bool] = None)[source]#

Methods

`__init__`(url, frame_type[, copy])
`frm_str`(input_str)	Create an instance of FrameGroup from it string representation.
`list_to_str`(urls)	Convert the list of urls to a string that can be pass to the .cfg file
`str_representation`(only_data_path, ...)	Util function to print the possible input string for this FrameGroup.

Attributes

`copy`
`frame_type`
`url`

class Info(value)[source]#

Bases: Enum

An enumeration.

static frm_str(input_str: str)[source]#: Create an instance of FrameGroup from it string representation.

static list_to_str(urls: Iterable)[source]#: Convert the list of urls to a string that can be pass to the .cfg file

str_representation(only_data_path: bool, with_copy: bool, with_prefix_key: bool) → str[source]#

Util function to print the possible input string for this FrameGroup.

Parameters:

only_data_path (bool) – if True consider the input file frame group is contained in the input file and the string representing the url can be only the data path
with_copy (bool) – if true display the copy information
with_prefix_key (bool) – if true provide the string with the keys as prefix (frame_type=XXX, copy=…)

Return type:

str