Image Class Reference

The Image class. More...

#include <RobotAPI/libraries/aron/core/type/variant/ndarray/Image.h>

+ Inheritance diagram for Image:

Public Member Functions

std::string getFullName () const override
 get the full name of this specific type More...
 
image::PixelType getPixelType () const
 Get the pixel type. More...
 
std::string getShortName () const override
 get a short name of this specific type More...
 
 Image (const Path &path={})
 
 Image (const type::dto::Image &, const Path &path)
 
void setPixelType (const image::PixelType type) const
 
type::dto::ImagePtr toImageDTO () const
 
- Public Member Functions inherited from NDArrayVariant< type::dto::Image, Image >
size_t childrenSize () const override
 
std::vector< VariantPtrgetChildren () const override
 get all child elements More...
 
std::string getDefaultValue () const
 
VariantPtr navigateAbsolute (const Path &path) const override
 naviate absolute More...
 
void setDefaultValue (const std::string &v)
 
virtual ~NDArrayVariant ()=default
 
- Public Member Functions inherited from SpecializedVariantBase< type::dto::Image, Image >
type::Maybe getMaybe () const override
 get the maybe type More...
 
VariantPtr navigateRelative (const Path &path) const override
 navigate relative More...
 
 operator type::dto::Image ()
 
bool operator== (const Image &other) const
 
bool operator== (const Variant &other) const override
 
void setMaybe (const type::Maybe m) override
 set the maybetype of this type More...
 
 SpecializedVariantBase (const type::Descriptor &descriptor, const Path &path)
 
 SpecializedVariantBase (const type::dto::Image &o, const type::Descriptor &descriptor, const Path &path)
 
type::dto::GenericTypePtr toAronDTO () const override
 convert this variant to a dto object. More...
 
virtual ~SpecializedVariantBase ()=default
 
- Public Member Functions inherited from Variant
virtual size_t childrenSize () const =0
 
virtual std::vector< VariantPtrgetChildren () const =0
 get all child elements More...
 
type::Descriptor getDescriptor () const
 
virtual type::Maybe getMaybe () const =0
 get the maybe type More...
 
Path getPath () const
 
bool operator== (const VariantPtr &other) const
 
std::string pathToString () const
 
virtual type::dto::GenericTypePtr toAronDTO () const =0
 convert this variant to a dto object. More...
 
 Variant (const type::Descriptor &descriptor, const Path &path=Path())
 
virtual ~Variant ()=default
 

Static Public Attributes

static const std::map< image::PixelType, std::string > Pixeltype2String
 
static const std::map< std::string, image::PixelType > String2Pixeltype
 

Additional Inherited Members

- Public Types inherited from Variant
using PointerType = VariantPtr
 
- Static Public Member Functions inherited from SpecializedVariantBase< type::dto::Image, Image >
static const ImageDynamicCast (const Variant &n)
 
static std::shared_ptr< ImageDynamicCast (const VariantPtr &n)
 
static ImageDynamicCast (Variant &n)
 
static std::shared_ptr< ImageDynamicCastAndCheck (const VariantPtr &n)
 
- Static Public Member Functions inherited from Variant
static VariantPtr FromAronDTO (const type::dto::GenericType &, const Path &=Path())
 create a variant object from an dto object More...
 
- Protected Attributes inherited from SpecializedVariantBase< type::dto::Image, Image >
type::dto::Image ::PointerType aron
 
- Protected Attributes inherited from Variant
const type::Descriptor descriptor
 
const Path path
 

Detailed Description

The Image class.

It represents the image type. The code generation manages, which code will be generated for this type object, e.g. c++ generates opencv code.

Definition at line 39 of file Image.h.

Constructor & Destructor Documentation

◆ Image() [1/2]

Image ( const Path path = {})

Definition at line 40 of file Image.cpp.

◆ Image() [2/2]

Image ( const type::dto::Image &  o,
const Path path 
)

Definition at line 45 of file Image.cpp.

Member Function Documentation

◆ getFullName()

std::string getFullName ( ) const
overridevirtual

get the full name of this specific type

Implements Variant.

Definition at line 76 of file Image.cpp.

◆ getPixelType()

image::PixelType getPixelType ( ) const

Get the pixel type.

Definition at line 57 of file Image.cpp.

+ Here is the caller graph for this function:

◆ getShortName()

std::string getShortName ( ) const
overridevirtual

get a short name of this specific type

Implements Variant.

Definition at line 70 of file Image.cpp.

◆ setPixelType()

void setPixelType ( const image::PixelType  type) const

Definition at line 63 of file Image.cpp.

◆ toImageDTO()

type::dto::ImagePtr toImageDTO ( ) const

Definition at line 51 of file Image.cpp.

Member Data Documentation

◆ Pixeltype2String

const std::map< image::PixelType, std::string > Pixeltype2String
static
Initial value:
{
{image::PixelType::RGB24, "RGB24"},
{image::PixelType::DEPTH32, "DEPTH32"}}

Definition at line 56 of file Image.h.

◆ String2Pixeltype

const std::map< std::string, image::PixelType > String2Pixeltype
static
Initial value:

Definition at line 57 of file Image.h.


The documentation for this class was generated from the following files:
armarx::aron::conversion::util::InvertMap
std::map< T2, T1 > InvertMap(const std::map< T1, T2 > &m)
Definition: Descriptor.h:42
armarx::aron::type::Image::Pixeltype2String
static const std::map< image::PixelType, std::string > Pixeltype2String
Definition: Image.h:56