hexrd.imageseries.load.function module
Adapter class for a custom function that takes an int as an argument and returns a 2D numpy array.
- class hexrd.imageseries.load.function.FunctionImageSeriesAdapter(fname, **kwargs)[source]
Bases:
ImageSeriesAdapterA highly customizable “generator-like” imageseries adapter
This adapter allows a function to be provided which should generate and return a frame for the index requested. It allows any function to be used that can provide a frame.
Note: to match behavior with other imageseries adapters, it may be advisable to return a new copy each time a frame is requested (rather than returning a locally stored/cached copy), since other parts of the code may modify the frame in place.
Parameters
- fname: None
should be None
func: a function that returns a numpy array for a index num_frames: the number of frames provided by the function metadata: dict (optional)
the metadata dictionary
- property dtype
- format = 'function'
- property metadata
Image sequence metadata
- property shape