ReaderParams Class Reference

The ReaderParams class manages the working resolution (WRes) and region of interest (ROI) for reader-objects. It provides access to the original image resolution as well as the current WRes and enforces constraints for a valid WRes, i.e. WRes is not larger than the original resolution in any dimension. More...

#include <readerparams.h>

Public Member Functions
	ReaderParams ()
	Default constructor initializing resolutions to zero and ROI usage to false.
void	initialize (const Resolution &originalResolution)
	Initializes the ReaderParams with an original resolution. The working resolution is also set to this resolution by default.
bool	setWorkingResolution (const Resolution &resolution)
	Sets the working resolution if it is valid (not exceeding original resolution).
bool	setRoi (const ROI &roi)
	Sets the region of interest (ROI).
bool	setUseRoi (bool useRoi)
	Enables or disables ROI usage.

Detailed Description

The ReaderParams class manages the working resolution (WRes) and region of interest (ROI) for reader-objects. It provides access to the original image resolution as well as the current WRes and enforces constraints for a valid WRes, i.e. WRes is not larger than the original resolution in any dimension.

Author

Dominik Wüst

Date

March 2025

Member Function Documentation

initialize()

void ReaderParams::initialize

(

const Resolution &

originalResolution

)

Initializes the ReaderParams with an original resolution. The working resolution is also set to this resolution by default.

Parameters

originalResolution

The resolution of the original image.

setRoi()

bool ReaderParams::setRoi

(

const ROI &

roi

)

Sets the region of interest (ROI).

Parameters

roi	The new ROI.

Returns

True if successfully set.

setUseRoi()

bool ReaderParams::setUseRoi ( bool  useRoi )

inline

Enables or disables ROI usage.

Parameters

useRoi

Whether to apply ROI cropping.

Returns

Always returns true.

setWorkingResolution()

bool ReaderParams::setWorkingResolution

(

const Resolution &

resolution

)

Sets the working resolution if it is valid (not exceeding original resolution).

Parameters

resolution

The new working resolution.

Returns

True if the resolution was updated successfully, false otherwise.

---

The documentation for this class was generated from the following files:

• iVS3D/src/iVS3D-core/model/reader/readerparams.h
• iVS3D/src/iVS3D-core/model/reader/readerparams.cpp