PCL
pcl::ReadoutOptions Class Reference

A structure to hold global pixel readout options. More...

#include <ReadoutOptions.h>

Public Types

enum  
 
enum  
 
enum  
 
enum  
 
typedef ReadoutData::value_type readout_data
 
typedef ReadoutMode::value_type readout_mode
 

Public Member Functions

 ReadoutOptions ()=default
 
 ReadoutOptions (const ReadoutOptions &)=default
 
int CoordinateItems () const
 
int CoordinatePrecision () const
 
readout_data Data () const
 
void DisableAlphaChannel (bool disable=true)
 
void DisableBroadcast (bool disable=true)
 
void DisableEclipticCoordinates (bool disable=true)
 
void DisableEquatorialCoordinates (bool disable=true)
 
void DisableGalacticCoordinates (bool disable=true)
 
void DisableMaskChannel (bool disable=true)
 
void DisablePreview (bool disable=true)
 
void DisablePreviewCenter (bool disable=true)
 
void EnableAlphaChannel (bool enable=true)
 
void EnableBroadcast (bool enable=true)
 
void EnableEclipticCoordinates (bool enable=true)
 
void EnableEquatorialCoordinates (bool enable=true)
 
void EnableGalacticCoordinates (bool enable=true)
 
void EnableMaskChannel (bool enable=true)
 
void EnablePreview (bool enable=true)
 
void EnablePreviewCenter (bool enable=true)
 
unsigned IntegerRange () const
 
bool IsBroadcastEnabled () const
 
bool IsInteger () const
 
bool IsReal () const
 
readout_mode Mode () const
 
ReadoutOptionsoperator= (const ReadoutOptions &)=default
 
int Precision () const
 
int PreviewSize () const
 
int PreviewZoomFactor () const
 
int ProbeSize () const
 
int RealCoordinatePrecision () const
 
void Set16BitRange ()
 
void Set32BitRange ()
 
void Set8BitRange ()
 
void SetCoordinateItems (int n)
 
void SetCoordinatePrecision (int n)
 
void SetData (readout_data d)
 
void SetInteger (bool b=true)
 
void SetIntegerRange (unsigned n)
 
void SetMode (readout_mode m)
 
void SetPrecision (int n)
 
void SetPreviewSize (int sz)
 
void SetPreviewZoomFactor (int zoom)
 
void SetProbeSize (int sz)
 
void SetReal (bool b=true)
 
bool ShowAlphaChannel () const
 
bool ShowEclipticCoordinates () const
 
bool ShowEquatorialCoordinates () const
 
bool ShowGalacticCoordinates () const
 
bool ShowMaskChannel () const
 
bool ShowPreview () const
 
bool ShowPreviewCenter () const
 

Static Public Member Functions

static ReadoutOptions GetCurrentOptions ()
 
static void SetCurrentOptions (const ReadoutOptions &)
 

Detailed Description

ReadoutOptions holds a set of parameters that define how PixInsight calculates and presents numerical pixel data obtained directly from images.

Readouts are generated dynamically when the user moves a pointing device cursor over an image in PixInsight. Generated readout data are shown on the Readout toolbar, normally located at the bottom of the core application's main window, and are also shown on popup windows when the user clicks on the image. Furthermore, when the user presses the mouse over an image, readout values are sent to interface windows that request them (see Readout Notification Functions). When those interfaces receive readout values, they usually provide some visual feedback, or use them to modify their behavior, as appropriate.

With ReadoutOptions you can specify two sets of parameters: a first set that defines how readout values are calcualted, and a second set that indicates how the numerical readout values are presented to the user.

The first parameter set includes the color space in which data is generated (e.g. RGB, HSV, CIE Lab, etc), the calculation mode used (average, median, minimum or maximum), and the size of the square box used to calculate readouts.

The second set of parameters lets you choose between real and integer readouts. Real readouts are normalized to the [0,1] interval, where 0=black and 1=white. For real readouts you may also specify a resolution degree in terms of the amount of decimal digits shown (from 0 to 15). Integer readouts are given in the range from zero to an arbitrary maximum value that you can specify from 1 to 2^32-1.

See also
ProcessInterface

Definition at line 159 of file ReadoutOptions.h.

Member Typedef Documentation

◆ readout_data

typedef ReadoutData::value_type pcl::ReadoutOptions::readout_data

Represents a pixel readout data mode.

Definition at line 166 of file ReadoutOptions.h.

◆ readout_mode

typedef ReadoutMode::value_type pcl::ReadoutOptions::readout_mode

Represents a pixel readout calculation mode.

Definition at line 171 of file ReadoutOptions.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Maximum allowed size of a square readout probe.

Definition at line 176 of file ReadoutOptions.h.

◆ anonymous enum

anonymous enum

Maximum allowed number of decimal digits for real readout display.

Definition at line 181 of file ReadoutOptions.h.

◆ anonymous enum

anonymous enum

Minimum and maximum allowed sizes of a square readout preview.

Definition at line 186 of file ReadoutOptions.h.

◆ anonymous enum

anonymous enum

Maximum allowed zoom factor for readout previews.

Definition at line 191 of file ReadoutOptions.h.

Constructor & Destructor Documentation

◆ ReadoutOptions() [1/2]

pcl::ReadoutOptions::ReadoutOptions ( )
default

Constructs a default ReadoutOptions object.

◆ ReadoutOptions() [2/2]

pcl::ReadoutOptions::ReadoutOptions ( const ReadoutOptions )
default

Copy constructor.

Member Function Documentation

◆ CoordinateItems()

int pcl::ReadoutOptions::CoordinateItems ( ) const
inline

Returns the number of items used in sexagesimal representations of celestial spherical coordinates. The returned value can be one of:

  • 1 - degrees/hours only.
  • 2 - degrees/hours and minutes.
  • 3 - degrees/hours, minutes and secons.

Definition at line 504 of file ReadoutOptions.h.

◆ CoordinatePrecision()

int pcl::ReadoutOptions::CoordinatePrecision ( ) const
inline

Returns the number of decimal digits represented for the last item in sexagesimal representations of celestial spherical coordinates. The returned value is an integer in the range [0,8].

Definition at line 527 of file ReadoutOptions.h.

◆ Data()

readout_data pcl::ReadoutOptions::Data ( ) const
inline

Returns the readout data mode in this ReadoutOptions object.

Definition at line 222 of file ReadoutOptions.h.

◆ DisableAlphaChannel()

void pcl::ReadoutOptions::DisableAlphaChannel ( bool  disable = true)
inline

Disables inclusion of alpha channel values on pixel readouts.

This is a convenience function, equivalent to: EnableAlphaChannel( !disable )

Definition at line 274 of file ReadoutOptions.h.

◆ DisableBroadcast()

void pcl::ReadoutOptions::DisableBroadcast ( bool  disable = true)
inline

Disables or enables broadcasting of readout notifications.

See also
readout notifications

Definition at line 577 of file ReadoutOptions.h.

◆ DisableEclipticCoordinates()

void pcl::ReadoutOptions::DisableEclipticCoordinates ( bool  disable = true)
inline

Disables ecliptic coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 463 of file ReadoutOptions.h.

◆ DisableEquatorialCoordinates()

void pcl::ReadoutOptions::DisableEquatorialCoordinates ( bool  disable = true)
inline

Disables equatorial coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 435 of file ReadoutOptions.h.

◆ DisableGalacticCoordinates()

void pcl::ReadoutOptions::DisableGalacticCoordinates ( bool  disable = true)
inline

Disables galactic coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 491 of file ReadoutOptions.h.

◆ DisableMaskChannel()

void pcl::ReadoutOptions::DisableMaskChannel ( bool  disable = true)
inline

Disables inclusion of mask channel values on pixel readouts.

This is a convenience function, equivalent to: EnableMaskChannel( !disable )

Definition at line 302 of file ReadoutOptions.h.

◆ DisablePreview()

void pcl::ReadoutOptions::DisablePreview ( bool  disable = true)
inline

Disables generation of real-time readout previews.

Definition at line 382 of file ReadoutOptions.h.

◆ DisablePreviewCenter()

void pcl::ReadoutOptions::DisablePreviewCenter ( bool  disable = true)
inline

Disables or enables crosshair center lines on real-time readout previews.

Definition at line 407 of file ReadoutOptions.h.

◆ EnableAlphaChannel()

void pcl::ReadoutOptions::EnableAlphaChannel ( bool  enable = true)
inline

Enables inclusion of alpha channel values on pixel readouts.

Definition at line 263 of file ReadoutOptions.h.

◆ EnableBroadcast()

void pcl::ReadoutOptions::EnableBroadcast ( bool  enable = true)
inline

Enables or disables broadcasting of readout notifications.

See also
readout notifications

Definition at line 568 of file ReadoutOptions.h.

◆ EnableEclipticCoordinates()

void pcl::ReadoutOptions::EnableEclipticCoordinates ( bool  enable = true)
inline

Enables ecliptic coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 454 of file ReadoutOptions.h.

◆ EnableEquatorialCoordinates()

void pcl::ReadoutOptions::EnableEquatorialCoordinates ( bool  enable = true)
inline

Enables equatorial coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 426 of file ReadoutOptions.h.

◆ EnableGalacticCoordinates()

void pcl::ReadoutOptions::EnableGalacticCoordinates ( bool  enable = true)
inline

Enables galactic coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 482 of file ReadoutOptions.h.

◆ EnableMaskChannel()

void pcl::ReadoutOptions::EnableMaskChannel ( bool  enable = true)
inline

Enables inclusion of mask channel values on pixel readouts.

Definition at line 291 of file ReadoutOptions.h.

◆ EnablePreview()

void pcl::ReadoutOptions::EnablePreview ( bool  enable = true)
inline

Enables generation of real-time readout previews.

Definition at line 374 of file ReadoutOptions.h.

◆ EnablePreviewCenter()

void pcl::ReadoutOptions::EnablePreviewCenter ( bool  enable = true)
inline

Enables or disables crosshair center lines on real-time readout previews.

Definition at line 399 of file ReadoutOptions.h.

◆ GetCurrentOptions()

static ReadoutOptions pcl::ReadoutOptions::GetCurrentOptions ( )
static

Returns the current readout options retrieved from the PixInsight core application.

◆ IntegerRange()

unsigned pcl::ReadoutOptions::IntegerRange ( ) const
inline

Returns the maximum value of integer pixel readouts.

Definition at line 645 of file ReadoutOptions.h.

◆ IsBroadcastEnabled()

bool pcl::ReadoutOptions::IsBroadcastEnabled ( ) const
inline

Returns true iff this ReadoutOptions object enables broadcasting of readout notifications.

See also
readout notifications

Definition at line 559 of file ReadoutOptions.h.

◆ IsInteger()

bool pcl::ReadoutOptions::IsInteger ( ) const
inline

Returns true iff this ReadoutOptions object disables floating point real pixel readouts.

This is a convenience function, equivalent to: !IsReal().

Definition at line 606 of file ReadoutOptions.h.

References pcl::ProcessParameterType::IsReal().

◆ IsReal()

bool pcl::ReadoutOptions::IsReal ( ) const
inline

Returns true iff this ReadoutOptions object enables floating point real pixel readouts.

Definition at line 586 of file ReadoutOptions.h.

◆ Mode()

readout_mode pcl::ReadoutOptions::Mode ( ) const
inline

Returns the readout calculation mode in this ReadoutOptions object.

Definition at line 238 of file ReadoutOptions.h.

◆ operator=()

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

Copy assignment operator. Returns a reference to this object.

◆ Precision()

int pcl::ReadoutOptions::Precision ( ) const
inline

Returns the precision for floating point real pixel readouts. The returned value is the number of decimal digits employed to represent real pixel readouts.

Definition at line 627 of file ReadoutOptions.h.

◆ PreviewSize()

int pcl::ReadoutOptions::PreviewSize ( ) const
inline

Returns the size in pixels of the real-time readout preview.

Definition at line 328 of file ReadoutOptions.h.

◆ PreviewZoomFactor()

int pcl::ReadoutOptions::PreviewZoomFactor ( ) const
inline

Returns the zoom factor applied to real-time readout previews. The returned value has the same meaning as for ImageWindow::ZoomFactor() and ImageWindow::SetViewport().

Definition at line 347 of file ReadoutOptions.h.

◆ ProbeSize()

int pcl::ReadoutOptions::ProbeSize ( ) const
inline

Returns the readout probe size in pixels.

Definition at line 310 of file ReadoutOptions.h.

◆ RealCoordinatePrecision()

int pcl::ReadoutOptions::RealCoordinatePrecision ( ) const
inline

Returns the actual number of decimal digits that should be used to represent spherical coordinates, as a function of the number of represented sexagesimal items. Returns a maximum of 3, 5 and 7 digits, respectively for 3, 2 and 1 represented items. These constraints allow for the representation of coordinates with milliarcsecond precision.

Definition at line 539 of file ReadoutOptions.h.

References pcl::Range().

◆ Set16BitRange()

void pcl::ReadoutOptions::Set16BitRange ( )
inline

Selects the 16-bit integer readout range.

This is a convenience function, equivalent to: SetIntegerRange( uint16_max )

Definition at line 675 of file ReadoutOptions.h.

References uint16_max.

◆ Set32BitRange()

void pcl::ReadoutOptions::Set32BitRange ( )
inline

Selects the 32-bit integer readout range.

This is a convenience function, equivalent to: SetIntegerRange( uint32_max )

Definition at line 686 of file ReadoutOptions.h.

References uint16_max, and uint32_max.

◆ Set8BitRange()

void pcl::ReadoutOptions::Set8BitRange ( )
inline

Selects the 8-bit integer readout range.

This is a convenience function, equivalent to: SetIntegerRange( uint8_max )

Definition at line 664 of file ReadoutOptions.h.

References uint8_max.

◆ SetCoordinateItems()

void pcl::ReadoutOptions::SetCoordinateItems ( int  n)
inline

Sets the number of items used in sexagesimal representations of celestial spherical coordinates. The specified value n must be one of:

  • 1 - degrees/hours only.
  • 2 - degrees/hours and minutes.
  • 3 - degrees/hours, minutes and secons.

Definition at line 517 of file ReadoutOptions.h.

References pcl::Range().

◆ SetCoordinatePrecision()

void pcl::ReadoutOptions::SetCoordinatePrecision ( int  n)
inline

Sets the number of decimal digits represented for the last item in sexagesimal representations of celestial spherical coordinates. The specified value n must be in the range [0,8].

Definition at line 549 of file ReadoutOptions.h.

References pcl::Range().

◆ SetCurrentOptions()

static void pcl::ReadoutOptions::SetCurrentOptions ( const ReadoutOptions )
static

Sets new readout options in the PixInsight core application.

◆ SetData()

void pcl::ReadoutOptions::SetData ( readout_data  d)
inline

Sets the readout data mode in this ReadoutOptions object.

Definition at line 230 of file ReadoutOptions.h.

◆ SetInteger()

void pcl::ReadoutOptions::SetInteger ( bool  b = true)
inline

Enables or disables integer pixel readouts.

This is a convenience function, equivalent to: SetReal( !b )

Definition at line 617 of file ReadoutOptions.h.

◆ SetIntegerRange()

void pcl::ReadoutOptions::SetIntegerRange ( unsigned  n)
inline

Sets the maximum value of integer pixel readouts.

Definition at line 653 of file ReadoutOptions.h.

References pcl::Range().

◆ SetMode()

void pcl::ReadoutOptions::SetMode ( readout_mode  m)
inline

Sets the readout calculation mode in this ReadoutOptions object.

Definition at line 246 of file ReadoutOptions.h.

◆ SetPrecision()

void pcl::ReadoutOptions::SetPrecision ( int  n)
inline

Sets the precision for floating point real pixel readouts. The specified value is the number n of decimal digits employed to represent real pixel readouts.

Definition at line 637 of file ReadoutOptions.h.

References pcl::Range().

◆ SetPreviewSize()

void pcl::ReadoutOptions::SetPreviewSize ( int  sz)
inline

Sets the size in pixels of the real-time readout preview. The specified size sz must be an odd integer in the range [15,127].

Definition at line 337 of file ReadoutOptions.h.

References pcl::Range().

◆ SetPreviewZoomFactor()

void pcl::ReadoutOptions::SetPreviewZoomFactor ( int  zoom)
inline

Sets the zoom factor to apply for generation of real-time readout previews. The specified zoom factor must be in the range [1,16], and has the same meaning as zoom factors for ImageWindow::SetViewport().

Definition at line 357 of file ReadoutOptions.h.

References pcl::Range().

◆ SetProbeSize()

void pcl::ReadoutOptions::SetProbeSize ( int  sz)
inline

Sets the readout probe size in pixels. If a value of one is specified, readouts will be calculated for a single pixel. The specified size sz must be an odd integer in the range [1,15].

Definition at line 320 of file ReadoutOptions.h.

References pcl::Range().

◆ SetReal()

void pcl::ReadoutOptions::SetReal ( bool  b = true)
inline

Enables or disables floating point real pixel readouts.

Definition at line 594 of file ReadoutOptions.h.

◆ ShowAlphaChannel()

bool pcl::ReadoutOptions::ShowAlphaChannel ( ) const
inline

Returns true iff this ReadoutOptions object enables presentation of alpha channel pixel readouts.

Definition at line 255 of file ReadoutOptions.h.

◆ ShowEclipticCoordinates()

bool pcl::ReadoutOptions::ShowEclipticCoordinates ( ) const
inline

Returns true iff this ReadoutOptions object enables ecliptic coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 445 of file ReadoutOptions.h.

◆ ShowEquatorialCoordinates()

bool pcl::ReadoutOptions::ShowEquatorialCoordinates ( ) const
inline

Returns true iff this ReadoutOptions object enables equatorial coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 417 of file ReadoutOptions.h.

◆ ShowGalacticCoordinates()

bool pcl::ReadoutOptions::ShowGalacticCoordinates ( ) const
inline

Returns true iff this ReadoutOptions object enables galactic coordinates, which can be shown when the image has a valid astrometric solution.

Definition at line 473 of file ReadoutOptions.h.

◆ ShowMaskChannel()

bool pcl::ReadoutOptions::ShowMaskChannel ( ) const
inline

Returns true iff this ReadoutOptions object enables presentation of mask channel pixel readouts.

Definition at line 283 of file ReadoutOptions.h.

◆ ShowPreview()

bool pcl::ReadoutOptions::ShowPreview ( ) const
inline

Returns true iff this ReadoutOptions object enables generation of real-time readout previews.

Definition at line 366 of file ReadoutOptions.h.

◆ ShowPreviewCenter()

bool pcl::ReadoutOptions::ShowPreviewCenter ( ) const
inline

Returns true iff this ReadoutOptions object enables crosshair center lines on real-time readout previews.

Definition at line 391 of file ReadoutOptions.h.


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