Synapse.ML.Image.UnrollBinaryImage Class Reference

UnrollBinaryImage implements UnrollBinaryImage More...

Inheritance diagram for Synapse.ML.Image.UnrollBinaryImage:

Collaboration diagram for Synapse.ML.Image.UnrollBinaryImage:

Public Member Functions
	UnrollBinaryImage ()
	Creates a UnrollBinaryImage without any parameters. More...
	UnrollBinaryImage (string uid)
	Creates a UnrollBinaryImage with a UID that is used to give the UnrollBinaryImage a unique ID. More...
UnrollBinaryImage	SetHeight (int value)
	Sets value for height More...
UnrollBinaryImage	SetInputCol (string value)
	Sets value for inputCol More...
UnrollBinaryImage	SetNChannels (int value)
	Sets value for nChannels More...
UnrollBinaryImage	SetOutputCol (string value)
	Sets value for outputCol More...
UnrollBinaryImage	SetWidth (int value)
	Sets value for width More...
int	GetHeight ()
	Gets height value More...
string	GetInputCol ()
	Gets inputCol value More...
int	GetNChannels ()
	Gets nChannels value More...
string	GetOutputCol ()
	Gets outputCol value More...
int	GetWidth ()
	Gets width value More...
void	Save (string path)
	Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
JavaMLWriter	Write ()
	Returns a JavaMLWriter instance for this ML instance.
JavaMLReader< UnrollBinaryImage >	Read ()
	Get the corresponding JavaMLReader instance. More...

Static Public Member Functions
static UnrollBinaryImage	Load (string path)
	Loads the UnrollBinaryImage that was previously saved using Save(string). More...

Detailed Description

UnrollBinaryImage implements UnrollBinaryImage

Constructor & Destructor Documentation

UnrollBinaryImage() [1/2]

Synapse.ML.Image.UnrollBinaryImage.UnrollBinaryImage ( )

inline

Creates a UnrollBinaryImage without any parameters.

UnrollBinaryImage() [2/2]

Synapse.ML.Image.UnrollBinaryImage.UnrollBinaryImage ( string  uid )

inline

Creates a UnrollBinaryImage with a UID that is used to give the UnrollBinaryImage a unique ID.

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

GetHeight()

int Synapse.ML.Image.UnrollBinaryImage.GetHeight

(

)

Gets height value

Returns

height: the width of the image

GetInputCol()

string Synapse.ML.Image.UnrollBinaryImage.GetInputCol

(

)

Gets inputCol value

Returns

inputCol: The name of the input column

GetNChannels()

int Synapse.ML.Image.UnrollBinaryImage.GetNChannels

(

)

Gets nChannels value

Returns

nChannels: the number of channels of the target image

GetOutputCol()

string Synapse.ML.Image.UnrollBinaryImage.GetOutputCol

(

)

Gets outputCol value

Returns

outputCol: The name of the output column

GetWidth()

int Synapse.ML.Image.UnrollBinaryImage.GetWidth

(

)

Gets width value

Returns

width: the width of the image

Load()

static UnrollBinaryImage Synapse.ML.Image.UnrollBinaryImage.Load ( string  path )

static

Loads the UnrollBinaryImage that was previously saved using Save(string).

Parameters

path	The path the previous UnrollBinaryImage was saved to

Returns

New UnrollBinaryImage object, loaded from path.

Read()

JavaMLReader<UnrollBinaryImage> Synapse.ML.Image.UnrollBinaryImage.Read

(

)

Get the corresponding JavaMLReader instance.

Returns

an JavaMLReader<UnrollBinaryImage> instance for this ML instance.

Save()

void Synapse.ML.Image.UnrollBinaryImage.Save

(

string

path

)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters

path	The path to save the object to

SetHeight()

UnrollBinaryImage Synapse.ML.Image.UnrollBinaryImage.SetHeight

(

int

value

)

Sets value for height

Parameters

value

the width of the image

Returns

New UnrollBinaryImage object

SetInputCol()

UnrollBinaryImage Synapse.ML.Image.UnrollBinaryImage.SetInputCol

(

string

value

)

Sets value for inputCol

Parameters

value

The name of the input column

Returns

New UnrollBinaryImage object

SetNChannels()

UnrollBinaryImage Synapse.ML.Image.UnrollBinaryImage.SetNChannels

(

int

value

)

Sets value for nChannels

Parameters

value

the number of channels of the target image

Returns

New UnrollBinaryImage object

SetOutputCol()

UnrollBinaryImage Synapse.ML.Image.UnrollBinaryImage.SetOutputCol

(

string

value

)

Sets value for outputCol

Parameters

value

The name of the output column

Returns

New UnrollBinaryImage object

SetWidth()

UnrollBinaryImage Synapse.ML.Image.UnrollBinaryImage.SetWidth

(

int

value

)

Sets value for width

Parameters

value

the width of the image

Returns

New UnrollBinaryImage object

---

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

• synapse/ml/image/UnrollBinaryImage.cs