RobWorkProject  23.9.11-
Public Types | Public Member Functions | Static Public Member Functions | List of all members

Representation of the Mathematica Image function. More...

#include <Image.hpp>

Inherits Mathematica::FunctionBase.

Public Types

typedef rw::core::Ptr< ImagePtr
 Smart pointer type.
 
- Public Types inherited from Mathematica::FunctionBase
typedef rw::core::Ptr< FunctionBasePtr
 Smart pointer type.
 
- Public Types inherited from Mathematica::Expression
enum  Type {
  String , Integer , Real , Symbol ,
  Function , Array
}
 Type of expression. More...
 
typedef rw::core::Ptr< ExpressionPtr
 Smart pointer type.
 
typedef enum rwlibs::mathematica::Mathematica::Expression::Type Type
 Type of expression.
 

Public Member Functions

 Image (rw::core::Ptr< const rw::sensor::Image > image)
 Construct a Image expression from a RobWork image. More...
 
 Image (const Mathematica::Expression &data)
 Construct a Image expression. More...
 
 Image (const Mathematica::Expression &data, const rw::core::PropertyMap &options)
 Construct a Image expression. More...
 
virtual ~Image ()
 Destructor.
 
virtual std::list< rw::core::Ptr< const Mathematica::Expression > > getArguments () const
 Get a list of arguments for this function. More...
 
virtual Mathematica::Expression::Ptr clone () const
 Make a copy of the expression. More...
 
void setImageSize (std::size_t width, std::size_t height)
 Set ImageSize option. More...
 
- Public Member Functions inherited from Mathematica::FunctionBase
 FunctionBase (const std::string &name)
 Construct new function. More...
 
std::string getName () const
 Get the name of the function. More...
 
Type getType () const
 Get the type of expression. More...
 
virtual void out (std::ostream &stream) const
 Print to output stream. More...
 
virtual void out (std::ostream &stream, std::size_t indent) const
 Print function by using indentations. More...
 

Static Public Member Functions

static rw::core::Ptr< rw::sensor::ImagetoRobWorkImage (const Mathematica::Expression &expression)
 Construct RobWork Image from Mathematica Image expression. More...
 

Additional Inherited Members

- Static Protected Member Functions inherited from Mathematica::Expression
template<typename Type >
static void toList (std::list< rw::core::Ptr< Type >> &)
 Helper function for extracting a list of arguments when given as a variable number of arguments. More...
 
template<typename Type , typename Exp , typename... T>
static void toList (std::list< rw::core::Ptr< Type >> &list, const Exp &r, T... t)
 Helper function for extracting a list of arguments when given as a variable number of arguments. More...
 
- Protected Attributes inherited from Mathematica::FunctionBase
std::string _name
 Name of the function.
 

Detailed Description

Representation of the Mathematica Image function.

Constructor & Destructor Documentation

◆ Image() [1/3]

Image ( rw::core::Ptr< const rw::sensor::Image image)

Construct a Image expression from a RobWork image.

Parameters
image[in] the image.

◆ Image() [2/3]

Image ( const Mathematica::Expression data)

Construct a Image expression.

Parameters
data[in] the data expression (e.g. a variable name, table/list expression, or data array).

◆ Image() [3/3]

Image ( const Mathematica::Expression data,
const rw::core::PropertyMap options 
)

Construct a Image expression.

Parameters
data[in] the data expression (e.g. a variable name, table/list expression, or data array).
options[in] the options to use (such as ColorSpace, ImageSize etc.)

Member Function Documentation

◆ clone()

virtual Mathematica::Expression::Ptr clone ( ) const
virtual

Make a copy of the expression.

Returns
a new copy.

Implements Mathematica::Expression.

◆ getArguments()

virtual std::list<rw::core::Ptr<const Mathematica::Expression> > getArguments ( ) const
virtual

Get a list of arguments for this function.

Returns
list of arguments.

Implements Mathematica::FunctionBase.

◆ setImageSize()

void setImageSize ( std::size_t  width,
std::size_t  height 
)

Set ImageSize option.

Parameters
width[in] the width.
height[in] the height.

◆ toRobWorkImage()

static rw::core::Ptr<rw::sensor::Image> toRobWorkImage ( const Mathematica::Expression expression)
static

Construct RobWork Image from Mathematica Image expression.

Parameters
expression[in] the expression to parse.
Returns
the parsed Image expression.
Exceptions
rw::core::Exceptionif parsing fails.

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