MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.param.DataLabelMappingParameter Class Reference

Specifies the parameters for the DataLabelMappingParameter used to map labels by the DataTransformer.TransformLabel when active. More...

Inheritance diagram for MyCaffe.param.DataLabelMappingParameter:
MyCaffe.param.OptionalParameter

Public Member Functions

 DataLabelMappingParameter (bool bActive)
 The constructor. More...
 
int MapLabel (int nLabel, int nBoost)
 Queries the mapped label for a given label. More...
 
DataLabelMappingParameter Load (BinaryReader br, bool bNewInstance=true)
 Load the and return a new DataLabelMappingParameter. More...
 
override void Copy (OptionalParameter src)
 Copies the specified source data label mapping parameter to this one. More...
 
DataLabelMappingParameter Clone ()
 Return a copy of this object. More...
 
override RawProto ToProto (string strName)
 Convert the DataLabelMappingParameter into a RawProto. More...
 
- Public Member Functions inherited from MyCaffe.param.OptionalParameter
 OptionalParameter (bool bActive=false)
 The constructor. More...
 

Static Public Member Functions

static new DataLabelMappingParameter FromProto (RawProto rp)
 Parses the parameter from a RawProto. More...
 
- Static Public Member Functions inherited from MyCaffe.param.OptionalParameter
static OptionalParameter FromProto (RawProto rp)
 Parses the parameter from a RawProto. More...
 

Properties

List< LabelMappingmapping [getset]
 Specifies the label mapping where the original label is mapped to the new label specified. More...
 
- Properties inherited from MyCaffe.param.OptionalParameter
bool Active [getset]
 When active, the parameter is used, otherwise it is ignored. More...
 

Detailed Description

Specifies the parameters for the DataLabelMappingParameter used to map labels by the DataTransformer.TransformLabel when active.

Definition at line 17 of file DataLabelMappingParameter.cs.

Constructor & Destructor Documentation

◆ DataLabelMappingParameter()

MyCaffe.param.DataLabelMappingParameter.DataLabelMappingParameter ( bool  bActive)

The constructor.

Parameters
bActiveSpecifies whether or not the parameter is active or not.

Definition at line 25 of file DataLabelMappingParameter.cs.

Member Function Documentation

◆ Clone()

DataLabelMappingParameter MyCaffe.param.DataLabelMappingParameter.Clone ( )

Return a copy of this object.

Returns
A new copy of the object is returned.

Definition at line 86 of file DataLabelMappingParameter.cs.

◆ Copy()

override void MyCaffe.param.DataLabelMappingParameter.Copy ( OptionalParameter  src)
virtual

Copies the specified source data label mapping parameter to this one.

Parameters
srcSpecifies the source data label mapping parameter.

Reimplemented from MyCaffe.param.OptionalParameter.

Definition at line 71 of file DataLabelMappingParameter.cs.

◆ FromProto()

static new DataLabelMappingParameter MyCaffe.param.DataLabelMappingParameter.FromProto ( RawProto  rp)
static

Parses the parameter from a RawProto.

Parameters
rpSpecifies the RawProto to parse.
Returns
A new instance of the parameter is returned.

Definition at line 116 of file DataLabelMappingParameter.cs.

◆ Load()

DataLabelMappingParameter MyCaffe.param.DataLabelMappingParameter.Load ( BinaryReader  br,
bool  bNewInstance = true 
)

Load the and return a new DataLabelMappingParameter.

Parameters
br
bNewInstance
Returns
The new object is returned.

Definition at line 56 of file DataLabelMappingParameter.cs.

◆ MapLabel()

int MyCaffe.param.DataLabelMappingParameter.MapLabel ( int  nLabel,
int  nBoost 
)

Queries the mapped label for a given label.

Parameters
nLabelSpecifies the label to query the mapped label from.
nBoostSpecifies the boost condition that must be met if specified.
Returns
The mapped label is returned.

Definition at line 45 of file DataLabelMappingParameter.cs.

◆ ToProto()

override RawProto MyCaffe.param.DataLabelMappingParameter.ToProto ( string  strName)
virtual

Convert the DataLabelMappingParameter into a RawProto.

Parameters
strNameSpecifies the RawProto name.
Returns
The RawProto containing the settings is returned.

Reimplemented from MyCaffe.param.OptionalParameter.

Definition at line 99 of file DataLabelMappingParameter.cs.

Property Documentation

◆ mapping

List<LabelMapping> MyCaffe.param.DataLabelMappingParameter.mapping
getset

Specifies the label mapping where the original label is mapped to the new label specified.

Definition at line 33 of file DataLabelMappingParameter.cs.


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