BaseDetector

BaseDetector#

class abtem.detectors.BaseDetector(to_cpu=True, url=None)[source]#

Base detector class.

Parameters:

to_cpu (bool, optional) – If True, copy the measurement data from the calculation device to CPU memory after applying the detector, otherwise the data stays on the respective devices. Default is True.
url (str, optional) – If this parameter is set the measurement data is saved at the specified location, typically a path to a local file. A URL can also include a protocol specifier like s3:// for remote data. If not set (default) the data stays in memory.

Methods

`__init__`([to_cpu, url])
`angular_limits`(waves)	The outer limits of the detected scattering angles in x and y [mrad] for the given waves.
`apply`(array_object)	Apply the transform to the given waves.
`copy`()	Make a copy.
`detect`(waves)	Detect the given waves producing a measurement.
`ensemble_blocks`([chunks])	Split the ensemble into an array of smaller ensembles.
`generate_blocks`([chunks])	Generate chunks of the ensemble.
`select_block`(index, chunks)	Select a block from the ensemble.

Attributes

`axes_metadata`	List of AxisMetadata.
`base_axes_metadata`	List of AxisMetadata of the base axes.
`base_shape`	Shape of the base axes.
`ensemble_axes_metadata`	Axes metadata describing the ensemble axes added to the waves when applying the transform.
`ensemble_shape`	The shape of the ensemble axes added to the waves when applying the transform.
`metadata`	Metadata added to the waves when applying the transform.
`shape`	Shape of the ensemble.
`to_cpu`	The measurements are copied to host memory.
`url`	The storage location of the measurement data.

abstract angular_limits(waves)[source]#

The outer limits of the detected scattering angles in x and y [mrad] for the given waves.

Parameters:: waves (BaseWaves) – The waves to derive the detector limits from.
Returns:: limits
Return type:: tuple of float

apply(array_object)#

Apply the transform to the given waves.

Parameters:: array_object (ArrayObject) – The array object to transform.
Returns:: transformed_array_object
Return type:: ArrayObject

property base_axes_metadata: list[AxisMetadata]#: List of AxisMetadata of the base axes.

detect(waves)[source]#

Detect the given waves producing a measurement.

property ensemble_axes_metadata: list[AxisMetadata]#: Axes metadata describing the ensemble axes added to the waves when applying the transform.

ensemble_blocks(chunks=None)#

Split the ensemble into an array of smaller ensembles.

Parameters:: chunks (iterable of tuples) – Block sizes along each dimension.
Return type:: Array

property ensemble_shape: tuple[int, ...]#: The shape of the ensemble axes added to the waves when applying the transform.

generate_blocks(chunks=1)#

Generate chunks of the ensemble.

Parameters:: chunks (iterable of tuples) – Block sizes along each dimension.

property metadata: dict#: Metadata added to the waves when applying the transform.

select_block(index, chunks)#

Select a block from the ensemble.

Parameters: