ITK  5.2.0
Insight Toolkit
Public Types | Static Public Attributes | List of all members
itk::RGBAPixel< TComponent > Class Template Reference
Data Representation Objects » Image Representation ObjectsGroup Core » | Module ITKCommon

#include <itkRGBAPixel.h>

+ Inheritance diagram for itk::RGBAPixel< TComponent >:
+ Collaboration diagram for itk::RGBAPixel< TComponent >:

Public Types

using BaseArray = FixedArray< TComponent, 4 >
 
using ComponentType = TComponent
 
using LuminanceType = typename NumericTraits< ComponentType >::RealType
 
using Self = RGBAPixel
 
using Superclass = FixedArray< TComponent, 4 >
 
- Public Types inherited from itk::FixedArray< TComponent, 4 >
using CArray = ValueType[VLength]
 
using const_iterator = const ValueType *
 
using const_pointer = const ValueType *
 
using const_reference = const ValueType &
 
using const_reverse_iterator = std::reverse_iterator< const_iterator >
 
using ConstIterator = const ValueType *
 
using Iterator = ValueType *
 
using iterator = ValueType *
 
using pointer = ValueType *
 
using reference = ValueType &
 
using reverse_iterator = std::reverse_iterator< iterator >
 
using SizeType = unsigned int
 
using ValueType = TComponent
 

Static Public Attributes

static constexpr unsigned int Dimension = 4
 
static constexpr unsigned int Length = 4
 
- Static Public Attributes inherited from itk::FixedArray< TComponent, 4 >
static constexpr unsigned int Dimension
 
static constexpr unsigned int Length
 
 RGBAPixel ()
 
 RGBAPixel (const RGBAPixel &)=default
 
RGBAPixel & operator= (const RGBAPixel &)=default
 
 RGBAPixel (RGBAPixel &&)=default
 
RGBAPixel & operator= (RGBAPixel &&)=default
 
 ~RGBAPixel ()=default
 
template<typename TRGBAPixelValueType >
 RGBAPixel (const RGBAPixel< TRGBAPixelValueType > &r)
 
 RGBAPixel (const ComponentType r[4])
 
 RGBAPixel (const ComponentType &r)
 
RGBAPixel & operator= (const ComponentType r[4])
 
Self operator+ (const Self &r) const
 
Self operator- (const Self &r) const
 
Self operator* (const ComponentType &r) const
 
Self operator/ (const ComponentType &r) const
 
const Self & operator+= (const Self &r)
 
const Self & operator-= (const Self &r)
 
const Self & operator*= (const ComponentType &r)
 
const Self & operator/= (const ComponentType &r)
 
bool operator< (const Self &r) const
 
bool operator== (const Self &r) const
 
ComponentType GetNthComponent (int c) const
 
ComponentType GetScalarValue () const
 
void SetNthComponent (int c, const ComponentType &v)
 
void SetRed (ComponentType red)
 
void SetGreen (ComponentType green)
 
void SetBlue (ComponentType blue)
 
void SetAlpha (ComponentType alpha)
 
void Set (ComponentType red, ComponentType green, ComponentType blue, ComponentType alpha)
 
const ComponentType & GetRed () const
 
const ComponentType & GetGreen () const
 
const ComponentType & GetBlue () const
 
const ComponentType & GetAlpha () const
 
LuminanceType GetLuminance () const
 
static unsigned int GetNumberOfComponents ()
 

Additional Inherited Members

- Public Member Functions inherited from itk::FixedArray< TComponent, 4 >
 FixedArray ()=default
 
 FixedArray (const FixedArray &)=default
 
 FixedArray (FixedArray &&)=default
 
 FixedArray (const ValueType r[VLength])
 
 FixedArray (const ValueType &)
 
 FixedArray (const std::array< ValueType, VLength > &stdArray)
 
 FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
 
 FixedArray (const TScalarValue *r)
 
FixedArray & operator= (const FixedArray &)=default
 
FixedArray & operator= (FixedArray &&)=default
 
FixedArray & operator= (const FixedArray< TFixedArrayValueType, VLength > &r)
 
FixedArray & operator= (const ValueType r[VLength])
 
 ~FixedArray ()=default
 
bool operator== (const FixedArray &r) const
 
bool operator!= (const FixedArray &r) const
 
reference operator[] (short index)
 
const_reference operator[] (short index) const
 
reference operator[] (unsigned short index)
 
const_reference operator[] (unsigned short index) const
 
reference operator[] (int index)
 
const_reference operator[] (int index) const
 
reference operator[] (unsigned int index)
 
const_reference operator[] (unsigned int index) const
 
reference operator[] (long index)
 
const_reference operator[] (long index) const
 
reference operator[] (unsigned long index)
 
const_reference operator[] (unsigned long index) const
 
reference operator[] (long long index)
 
const_reference operator[] (long long index) const
 
reference operator[] (unsigned long long index)
 
const_reference operator[] (unsigned long long index) const
 
void SetElement (unsigned int index, const_reference value)
 
const_reference GetElement (unsigned int index) const
 
ValueType * GetDataPointer ()
 
const ValueType * GetDataPointer () const
 
ValueType * data ()
 
const ValueType * data () const
 
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
 itkLegacyMacro (ReverseIterator rBegin())
 
 itkLegacyMacro (ConstReverseIterator rBegin() const)
 
 itkLegacyMacro (ReverseIterator rEnd())
 
 itkLegacyMacro (ConstReverseIterator rEnd() const)
 
const_iterator cbegin () const noexcept
 
iterator begin () noexcept
 
const_iterator begin () const noexcept
 
const_iterator cend () const noexcept
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
reverse_iterator rbegin ()
 
const_reverse_iterator rbegin () const
 
const_reverse_iterator crbegin () const
 
reverse_iterator rend ()
 
const_reverse_iterator rend () const
 
const_reverse_iterator crend () const
 
SizeType Size () const
 
constexpr SizeType size () const
 
void Fill (const ValueType &)
 
void swap (FixedArray &other)
 
- Static Public Member Functions inherited from itk::FixedArray< TComponent, 4 >
static FixedArray Filled (const ValueType &)
 

Detailed Description

template<typename TComponent = unsigned short>
class itk::RGBAPixel< TComponent >

Represent Red, Green, Blue and Alpha components for color images.

This class is templated over the representation used for each component.

The following syntax for assigning an index is allowed/suggested:

RGBAPixel<float> pixel; pixel = 1.0f, 0.0f, .5f, .8;
RGBAPixel<char> pixelArray[2];
pixelArray[0] = 255, 255, 255, 230;
pixelArray[1] = 255, 255, 244, 255;

Since RGBAPixel is a subclass of Array, you can access its components as: pixel[0], pixel[1], pixel[2], pixel[3]

ITK Sphinx Examples:
Examples
SphinxExamples/src/Core/Common/MakePartOfImageTransparent/Code.cxx, SphinxExamples/src/Core/Common/UseParallelizeImageRegion/Code.cxx, and SphinxExamples/src/IO/ImageBase/ConvertImageToAnotherType/Code.cxx.

Definition at line 59 of file itkRGBAPixel.h.

Member Typedef Documentation

◆ BaseArray

template<typename TComponent = unsigned short>
using itk::RGBAPixel< TComponent >::BaseArray = FixedArray<TComponent, 4>

Convenience type alias.

Definition at line 73 of file itkRGBAPixel.h.

◆ ComponentType

template<typename TComponent = unsigned short>
using itk::RGBAPixel< TComponent >::ComponentType = TComponent

Define the component type.

Definition at line 76 of file itkRGBAPixel.h.

◆ LuminanceType

template<typename TComponent = unsigned short>
using itk::RGBAPixel< TComponent >::LuminanceType = typename NumericTraits<ComponentType>::RealType

Definition at line 77 of file itkRGBAPixel.h.

◆ Self

template<typename TComponent = unsigned short>
using itk::RGBAPixel< TComponent >::Self = RGBAPixel

Standard class type aliases.

Definition at line 63 of file itkRGBAPixel.h.

◆ Superclass

template<typename TComponent = unsigned short>
using itk::RGBAPixel< TComponent >::Superclass = FixedArray<TComponent, 4>

Definition at line 64 of file itkRGBAPixel.h.

Constructor & Destructor Documentation

◆ RGBAPixel() [1/6]

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::RGBAPixel ( )
inline

Default constructors

Definition at line 80 of file itkRGBAPixel.h.

◆ RGBAPixel() [2/6]

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::RGBAPixel ( const RGBAPixel< TComponent > &  )
default

Default constructors

◆ RGBAPixel() [3/6]

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::RGBAPixel ( RGBAPixel< TComponent > &&  )
default

Default constructors

◆ ~RGBAPixel()

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::~RGBAPixel ( )
default

Default constructors

◆ RGBAPixel() [4/6]

template<typename TComponent = unsigned short>
template<typename TRGBAPixelValueType >
itk::RGBAPixel< TComponent >::RGBAPixel ( const RGBAPixel< TRGBAPixelValueType > &  r)
inline

Pass-through constructor for the Array base class.

Definition at line 92 of file itkRGBAPixel.h.

◆ RGBAPixel() [5/6]

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::RGBAPixel ( const ComponentType  r[4])
inline

Default constructors

Definition at line 95 of file itkRGBAPixel.h.

◆ RGBAPixel() [6/6]

template<typename TComponent = unsigned short>
itk::RGBAPixel< TComponent >::RGBAPixel ( const ComponentType &  r)
inline

Default constructors

Definition at line 98 of file itkRGBAPixel.h.

Member Function Documentation

◆ GetAlpha()

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBAPixel< TComponent >::GetAlpha ( ) const
inline

Get the Alpha component.

Definition at line 226 of file itkRGBAPixel.h.

◆ GetBlue()

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBAPixel< TComponent >::GetBlue ( ) const
inline

Get the Blue component.

Definition at line 219 of file itkRGBAPixel.h.

◆ GetGreen()

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBAPixel< TComponent >::GetGreen ( ) const
inline

Get the Green component.

Definition at line 212 of file itkRGBAPixel.h.

◆ GetLuminance()

template<typename TComponent = unsigned short>
LuminanceType itk::RGBAPixel< TComponent >::GetLuminance ( ) const

Get Luminance out of RGB

Referenced by itk::NumericTraits< RGBAPixel< T > >::IsNegative(), itk::NumericTraits< RGBAPixel< T > >::IsNonnegative(), itk::NumericTraits< RGBAPixel< T > >::IsNonpositive(), and itk::NumericTraits< RGBAPixel< T > >::IsPositive().

◆ GetNthComponent()

template<typename TComponent = unsigned short>
ComponentType itk::RGBAPixel< TComponent >::GetNthComponent ( int  c) const
inline

Return the value for the Nth component.

Definition at line 142 of file itkRGBAPixel.h.

◆ GetNumberOfComponents()

template<typename TComponent = unsigned short>
static unsigned int itk::RGBAPixel< TComponent >::GetNumberOfComponents ( )
inlinestatic

Return the number of components.

Definition at line 135 of file itkRGBAPixel.h.

◆ GetRed()

template<typename TComponent = unsigned short>
const ComponentType& itk::RGBAPixel< TComponent >::GetRed ( ) const
inline

Get the Red component.

Definition at line 205 of file itkRGBAPixel.h.

◆ GetScalarValue()

template<typename TComponent = unsigned short>
ComponentType itk::RGBAPixel< TComponent >::GetScalarValue ( ) const
inline

Return the Euclidean norm of the vector defined by the RGB components. Alpha is not used.

Definition at line 149 of file itkRGBAPixel.h.

◆ operator*()

template<typename TComponent = unsigned short>
Self itk::RGBAPixel< TComponent >::operator* ( const ComponentType &  r) const

Default constructors

◆ operator*=()

template<typename TComponent = unsigned short>
const Self& itk::RGBAPixel< TComponent >::operator*= ( const ComponentType &  r)

Default constructors

◆ operator+()

template<typename TComponent = unsigned short>
Self itk::RGBAPixel< TComponent >::operator+ ( const Self &  r) const

Aritmetic operations between pixels. Return a new RGBAPixel.

◆ operator+=()

template<typename TComponent = unsigned short>
const Self& itk::RGBAPixel< TComponent >::operator+= ( const Self &  r)

Arithmetic-assignment operators.

◆ operator-()

template<typename TComponent = unsigned short>
Self itk::RGBAPixel< TComponent >::operator- ( const Self &  r) const

Default constructors

◆ operator-=()

template<typename TComponent = unsigned short>
const Self& itk::RGBAPixel< TComponent >::operator-= ( const Self &  r)

Default constructors

◆ operator/()

template<typename TComponent = unsigned short>
Self itk::RGBAPixel< TComponent >::operator/ ( const ComponentType &  r) const

Default constructors

◆ operator/=()

template<typename TComponent = unsigned short>
const Self& itk::RGBAPixel< TComponent >::operator/= ( const ComponentType &  r)

Default constructors

◆ operator<()

template<typename TComponent = unsigned short>
bool itk::RGBAPixel< TComponent >::operator< ( const Self &  r) const

Implements strict weak ordering. For use in STL, e.g. std::map.

◆ operator=() [1/3]

template<typename TComponent = unsigned short>
RGBAPixel& itk::RGBAPixel< TComponent >::operator= ( const ComponentType  r[4])

Pass-through assignment operator for the Array base class.

◆ operator=() [2/3]

template<typename TComponent = unsigned short>
RGBAPixel& itk::RGBAPixel< TComponent >::operator= ( const RGBAPixel< TComponent > &  )
default

Default constructors

◆ operator=() [3/3]

template<typename TComponent = unsigned short>
RGBAPixel& itk::RGBAPixel< TComponent >::operator= ( RGBAPixel< TComponent > &&  )
default

Default constructors

◆ operator==()

template<typename TComponent = unsigned short>
bool itk::RGBAPixel< TComponent >::operator== ( const Self &  r) const

Default constructors

◆ Set()

template<typename TComponent = unsigned short>
void itk::RGBAPixel< TComponent >::Set ( ComponentType  red,
ComponentType  green,
ComponentType  blue,
ComponentType  alpha 
)
inline

Set the four components.

Definition at line 194 of file itkRGBAPixel.h.

◆ SetAlpha()

template<typename TComponent = unsigned short>
void itk::RGBAPixel< TComponent >::SetAlpha ( ComponentType  alpha)
inline

Set the Alpha component.

Definition at line 187 of file itkRGBAPixel.h.

◆ SetBlue()

template<typename TComponent = unsigned short>
void itk::RGBAPixel< TComponent >::SetBlue ( ComponentType  blue)
inline

Set the Blue component.

Definition at line 180 of file itkRGBAPixel.h.

◆ SetGreen()

template<typename TComponent = unsigned short>
void itk::RGBAPixel< TComponent >::SetGreen ( ComponentType  green)
inline

Set the Green component.

Definition at line 173 of file itkRGBAPixel.h.

◆ SetNthComponent()

template<typename TComponent = unsigned short>
void itk::RGBAPixel< TComponent >::SetNthComponent ( int  c,
const ComponentType &  v 
)
inline

Set the Nth component to v.

Definition at line 159 of file itkRGBAPixel.h.

◆ SetRed()

template<typename TComponent = unsigned short>
void itk::RGBAPixel< TComponent >::SetRed ( ComponentType  red)
inline

Set the Red component.

Definition at line 166 of file itkRGBAPixel.h.

Member Data Documentation

◆ Dimension

template<typename TComponent = unsigned short>
constexpr unsigned int itk::RGBAPixel< TComponent >::Dimension = 4
staticconstexpr

Dimension of the vector space.

Definition at line 67 of file itkRGBAPixel.h.

◆ Length

template<typename TComponent = unsigned short>
constexpr unsigned int itk::RGBAPixel< TComponent >::Length = 4
staticconstexpr

Length of the pixel.

Definition at line 70 of file itkRGBAPixel.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Thu Apr 1 2021 02:31:58 for ITK by   doxygen 1.8.16