PCL
pcl::ImageSelections Struct Reference

A structure used to store rectangular image selections, channel ranges, anchor points, and clipping ranges. More...

#include <ImageSelections.h>

Public Member Functions

 ImageSelections ()=default
 
 ImageSelections (const ImageSelections &)=default
 
ImageSelectionsoperator= (const ImageSelections &)=default
 

Public Attributes

int channel = 0
 First selected channel.
 
double clipHigh = 1.0
 Clipping range, upper bound.
 
double clipLow = 0.0
 Clipping range, lower bound.
 
bool clippedHigh = false
 Use range clipping, high pixels.
 
bool clippedLow = false
 Use range clipping, low pixels.
 
int lastChannel = 0
 Last selected channel.
 
Point point = 0
 Current anchor point.
 
Rect rectangle = 0
 Current rectangular selection.
 

Detailed Description

ImageSelections defines a rectangular area, a channel range, and an anchor point that can be used as a selection for 2D images.

This structure also defines a clipping range in the normalized [0,1] range. Range clipping is used for calculation of statistics such as mean, median, standard deviation, average and median deviations, etc.

Definition at line 81 of file ImageSelections.h.

Constructor & Destructor Documentation

◆ ImageSelections() [1/2]

pcl::ImageSelections::ImageSelections ( )
default

Constructs a default ImageSelections instance:

  • Only the first channel selected: channel = lastChannel = 0.
  • Empty rectangular selection: rectangle = Rect( 0 ).
  • Anchor point at the origin of image coordinates: point = Point( 0 ).
  • Clipping range lower bound = 0.0
  • Clipping range upper bound = 1.0
  • Range clipping disabled.

◆ ImageSelections() [2/2]

pcl::ImageSelections::ImageSelections ( const ImageSelections )
default

Copy constructor.

Member Function Documentation

◆ operator=()

ImageSelections& pcl::ImageSelections::operator= ( const ImageSelections )
default

Assignment operator. Returns a reference to this object.


The documentation for this struct was generated from the following file: