Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Lime.SuperpixelTransformer Class Reference

SuperpixelTransformer implements SuperpixelTransformer More...

Inheritance diagram for Synapse.ML.Lime.SuperpixelTransformer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Lime.SuperpixelTransformer:
Collaboration graph
[legend]

Public Member Functions

 SuperpixelTransformer ()
 Creates a SuperpixelTransformer without any parameters. More...
 
 SuperpixelTransformer (string uid)
 Creates a SuperpixelTransformer with a UID that is used to give the SuperpixelTransformer a unique ID. More...
 
SuperpixelTransformer SetCellSize (double value)
 Sets value for cellSize More...
 
SuperpixelTransformer SetInputCol (string value)
 Sets value for inputCol More...
 
SuperpixelTransformer SetModifier (double value)
 Sets value for modifier More...
 
SuperpixelTransformer SetOutputCol (string value)
 Sets value for outputCol More...
 
double GetCellSize ()
 Gets cellSize value More...
 
string GetInputCol ()
 Gets inputCol value More...
 
double GetModifier ()
 Gets modifier value More...
 
string GetOutputCol ()
 Gets outputCol 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< SuperpixelTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static SuperpixelTransformer Load (string path)
 Loads the SuperpixelTransformer that was previously saved using Save(string). More...
 

Detailed Description

SuperpixelTransformer implements SuperpixelTransformer

Constructor & Destructor Documentation

◆ SuperpixelTransformer() [1/2]

Synapse.ML.Lime.SuperpixelTransformer.SuperpixelTransformer ( )
inline

Creates a SuperpixelTransformer without any parameters.

◆ SuperpixelTransformer() [2/2]

Synapse.ML.Lime.SuperpixelTransformer.SuperpixelTransformer ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetCellSize()

double Synapse.ML.Lime.SuperpixelTransformer.GetCellSize ( )

Gets cellSize value

Returns
cellSize: Number that controls the size of the superpixels

◆ GetInputCol()

string Synapse.ML.Lime.SuperpixelTransformer.GetInputCol ( )

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetModifier()

double Synapse.ML.Lime.SuperpixelTransformer.GetModifier ( )

Gets modifier value

Returns
modifier: Controls the trade-off spatial and color distance

◆ GetOutputCol()

string Synapse.ML.Lime.SuperpixelTransformer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ Load()

static SuperpixelTransformer Synapse.ML.Lime.SuperpixelTransformer.Load ( string  path)
static

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

Parameters
pathThe path the previous SuperpixelTransformer was saved to
Returns
New SuperpixelTransformer object, loaded from path.

◆ Read()

JavaMLReader<SuperpixelTransformer> Synapse.ML.Lime.SuperpixelTransformer.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<SuperpixelTransformer> instance for this ML instance.

◆ Save()

void Synapse.ML.Lime.SuperpixelTransformer.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
pathThe path to save the object to

◆ SetCellSize()

SuperpixelTransformer Synapse.ML.Lime.SuperpixelTransformer.SetCellSize ( double  value)

Sets value for cellSize

Parameters
valueNumber that controls the size of the superpixels
Returns
New SuperpixelTransformer object

◆ SetInputCol()

SuperpixelTransformer Synapse.ML.Lime.SuperpixelTransformer.SetInputCol ( string  value)

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New SuperpixelTransformer object

◆ SetModifier()

SuperpixelTransformer Synapse.ML.Lime.SuperpixelTransformer.SetModifier ( double  value)

Sets value for modifier

Parameters
valueControls the trade-off spatial and color distance
Returns
New SuperpixelTransformer object

◆ SetOutputCol()

SuperpixelTransformer Synapse.ML.Lime.SuperpixelTransformer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New SuperpixelTransformer object

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