Struct ROIStatProcessor 

pub struct ROIStatProcessor { /* private fields */ }

Processor that computes ROI statistics on 2D arrays.

Implementations

impl ROIStatProcessor

pub fn new(rois: Vec<ROIStatROI>, ts_num_points: usize) -> Self

Create a new processor with the given ROI definitions.

pub fn params_handle(&self) -> Arc<Mutex<ROIStatParams>>

Get a shared handle to the params (populated after register_params is called).

pub fn results(&self) -> &[ROIStatResult]

Get the current results for all ROIs.

pub fn rois(&self) -> &[ROIStatROI]

Get the ROI definitions.

pub fn rois_mut(&mut self) -> &mut Vec<ROIStatROI>

Mutable access to ROI definitions.

pub fn set_ts_mode(&mut self, mode: TSMode)

Set the time series mode.

pub fn ts_buffer(&self, roi_index: usize, stat_index: usize) -> &[f64]

Get time series buffer for a specific ROI and stat index. stat_index: 0=min, 1=max, 2=mean, 3=total, 4=net

pub fn set_ts_sender(&mut self, sender: TimeSeriesSender)

Set the sender for pushing time series data to a TimeSeriesPortDriver.

pub fn compute_roi_stats( data: &NDDataBuffer, ndims: usize, array_size_x: usize, offset: [usize; 2], size: [usize; 2], bgd_width: usize, ) -> ROIStatResult

Compute statistics for one already-clamped ROI, mirroring the C doComputeStatistics (NDPluginROIStat.cpp:30-139). array_size_x is the array’s X dimension (the row stride, = C arraySize[0]). ndims selects the 1-D (single X strip) or 2-D (rectangle) layout. Background pixels are summed exactly as C does: for 1-D the two X-end strips, for 2-D the four-edge border. Both can double-count in the degenerate thick-border case (2*bgd_width > size), matching C.

Trait Implementations

impl NDPluginProcess for ROIStatProcessor

fn process_array( &mut self, array: &NDArray, _pool: &NDArrayPool, ) -> ProcessResult

Process one array. Return output arrays and param updates.

fn plugin_type(&self) -> &str

Plugin type name for PLUGIN_TYPE param.

fn register_params( &mut self, base: &mut PortDriverBase, ) -> Result<(), AsynError>

Register plugin-specific params on the base. Called once during construction.

fn on_param_change( &mut self, reason: usize, snapshot: &PluginParamSnapshot, ) -> ParamChangeResult

Called when a param changes. Reason is the param index. Return param updates to be written back to the port driver.

fn compression_aware(&self) -> bool

Whether this plugin can process compressed (codec != None) arrays (C++ compressionAware_, G3). Defaults to false: a plugin that operates on raw pixels must not be handed compressed bytes — the runtime drops compressed input and counts it into DroppedArrays. A codec/file plugin that understands compressed data overrides this.

fn does_array_callbacks(&self) -> bool

Whether this plugin delivers arrays to downstream plugins, i.e. the initial NDArrayCallbacks param value. Defaults to true: most plugins do array callbacks. Terminal plugins that never deliver downstream (NDPluginStdArrays, NDPluginAttribute, every NDPluginFile writer) override this to false so the param reflects the behaviour, matching C (e.g. NDPluginFile.cpp:948 setIntegerParam(NDArrayCallbacks, 0)).

fn array_data_handle( &self, ) -> Option<Arc<Mutex<RawMutex, Option<Arc<NDArray>>>>>

Return a handle to the latest NDArray data for array reads. Override this in plugins like NDPluginStdArrays that serve pixel data via readInt8Array/readInt16Array/etc.