Trace#

class specreduce.tracing.Trace(image: NDData)[source]#

Bases: object

Basic tracing class that by default traces the middle of the image.

Parameters:
imageNDData-like or array-like, required

Image to be traced

Attributes:
shapetuple

Shape of the array describing the trace

Attributes Summary

image

mask_treatment

shape

valid_mask_treatment_methods

Methods Summary

shift(delta)

Shift the trace by delta pixels perpendicular to the axis being traced

validate_masking_options()

Attributes Documentation

image: NDData = <dataclasses._MISSING_TYPE object>#
mask_treatment#
shape#
valid_mask_treatment_methods#

Methods Documentation

shift(delta)[source]#

Shift the trace by delta pixels perpendicular to the axis being traced

Parameters:
deltafloat

Shift to be applied to the trace

validate_masking_options()[source]#