INParam (irisnet-java-client 2.4.1 API)

java.lang.Object
- de.irisnet.java.client.model.INParam

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen")
public class INParam
extends Object
```
A single parameter set for one object, for example face, describing the behaviour of the AI. Each object has default parameters that are set if these are empty.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class INParam.InClassEnum
The classification of the object, that the element refers to.

Nested Classes
Modifier and Type	Class and Description
`static class`	`INParam.InClassEnum` The classification of the object, that the element refers to.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_DRAW_MODE`
`static String`	`SERIALIZED_NAME_GREY`
`static String`	`SERIALIZED_NAME_IN_CLASS`
`static String`	`SERIALIZED_NAME_MAX`
`static String`	`SERIALIZED_NAME_MIN`
`static String`	`SERIALIZED_NAME_SCALE`
`static String`	`SERIALIZED_NAME_SEVERITY`

Constructor Summary

Constructors
Constructor and Description

INParam()

Constructors
Constructor and Description
`INParam()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`INParam`	`drawMode(Integer drawMode)`
`boolean`	`equals(Object o)`
`Integer`	`getDrawMode()` The draw mode that will be used for the creating the media.
`Integer`	`getGrey()` A grey scale color to use for masking.
`INParam.InClassEnum`	`getInClass()` The classification of the object, that the element refers to.
`Integer`	`getMax()` The maximum amount of objects allowed on the source media.
`Integer`	`getMin()` The minimum amount of objects allowed on the source media.
`Float`	`getScale()` Scale of the draw rectangle around the classification object.
`Integer`	`getSeverity()` Set a value to define the severity of a broken rule of the given classification object.
`INParam`	`grey(Integer grey)`
`int`	`hashCode()`
`INParam`	`inClass(INParam.InClassEnum inClass)`
`INParam`	`max(Integer max)`
`INParam`	`min(Integer min)`
`INParam`	`scale(Float scale)`
`void`	`setDrawMode(Integer drawMode)`
`void`	`setGrey(Integer grey)`
`void`	`setInClass(INParam.InClassEnum inClass)`
`void`	`setMax(Integer max)`
`void`	`setMin(Integer min)`
`void`	`setScale(Float scale)`
`void`	`setSeverity(Integer severity)`
`INParam`	`severity(Integer severity)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_IN_CLASS
```
public static final String SERIALIZED_NAME_IN_CLASS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MIN
```
public static final String SERIALIZED_NAME_MIN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MAX
```
public static final String SERIALIZED_NAME_MAX
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SEVERITY
```
public static final String SERIALIZED_NAME_SEVERITY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DRAW_MODE
```
public static final String SERIALIZED_NAME_DRAW_MODE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_GREY
```
public static final String SERIALIZED_NAME_GREY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SCALE
```
public static final String SERIALIZED_NAME_SCALE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - INParam
```
public INParam()
```
- Method Detail
  - inClass
```
public INParam inClass(INParam.InClassEnum inClass)
```
  - getInClass
```
@Nullable
public INParam.InClassEnum getInClass()
```
    The classification of the object, that the element refers to. Default parameter values are defined per classification object. The following list contains the default values for 'min', 'max' and 'drawMode' in order. * _face_ _(1, 3, 0)_ - Classification for human faces. * _child (*)_ _(0, 0, 6)_ - Recognizes children's faces. * _adult (*)_ _(0, -1, 0)_ - Recognizes faces of adults that are not considered seniors. * _senior (*)_ _(0, -1, 0)_ - Recognizes faces of seniors. * _pose_ _(0, 0, 0)_ - The age can not be estimated, due to a pose that hides facial features. * _female (*)_ _(0, -1, 0)_ - Recognizes female faces. * _male (*)_ _(0, -1, 0)_ - Recognizes male faces. * _hand_ _(0, -1, 0)_ - Classification for recognizing hands. * _foot_ _(0, -1, 0)_ - Classification for recognizing feet. * _footwear_ _(0, -1, 0)_ - Classification for recognizing footwear. * _hair_ _(0, -1, 0)_ - Classification for recognizing hair. * _hairless_ _(0, -1, 0)_ - Classification for recognizing no hair. * _beard_ _(0, -1, 0)_ - Classification for recognizing beards. * _moustache_ _(0, -1, 0)_ - Classification for recognizing moustaches. * _headpiece_ _(0, -1, 0)_ - Classification for recognizing headpieces. * _glasses_ _(0, -1, 0)_ - Classification for recognizing glasses. * _sunglasses_ _(0, -1, 0)_ - Classification for recognizing sunglasses. * _mask_ _(0, -1, 0)_ - Classification for recognizing medical masks. * _breast_ _(0, 0, 2)_ - Object that recognizes female breasts. * _vulva_ _(0, 0, 2)_ - Object that recognizes vulvae. * _penis_ _(0, 0, 2)_ - Object that recognizes penises. * _vagina_ _(0, 0, 2)_ - Object that recognizes vaginae. * _buttocks_ _(0, 0, 2)_ - Object that recognizes buttocks. * _anus_ _(0, 0, 2)_ - Object that recognizes ani. * _toy_ _(0, -1, 0)_ - Object that recognizes sex toys. * _oral_ _(0, 0, 2)_ - Object that recognizes oral sex. * _penetration_ _(0, 0, 2)_ - Object that recognizes a sexual penetration penetration. * _illegalSymbols_ _(0, 0, 1)_ - Classification for symbols that are not permitted in Germany. * _textRecognition_ _(0, 6, 6)_ - Classification for recognizing text occurrences. _Classification objects that are marked with (*) are sub-classifications of face. Both face and the marked classification are affected by the given parameter values._ _Please be aware that the default values can be subject to change. This is due to the difficulty of recognizing certain objects e.g. objects that are classified as toy._
    
    Returns:
    
    inClass
  - setInClass
```
public void setInClass(INParam.InClassEnum inClass)
```
  - min
```
public INParam min(Integer min)
```
  - getMin
```
@Nullable
public Integer getMin()
```
    The minimum amount of objects allowed on the source media. Setting the value to -1 will cause the AI to ignore this rule.
    
    Returns:
    
    min
  - setMin
```
public void setMin(Integer min)
```
  - max
```
public INParam max(Integer max)
```
  - getMax
```
@Nullable
public Integer getMax()
```
    The maximum amount of objects allowed on the source media. Setting the value to -1 will cause the AI to ignore this rule.
    
    Returns:
    
    max
  - setMax
```
public void setMax(Integer max)
```
  - severity
```
public INParam severity(Integer severity)
```
  - getSeverity
```
@Nullable
public Integer getSeverity()
```
    Set a value to define the severity of a broken rule of the given classification object. minimum: 0 maximum: 1000
    
    Returns:
    
    severity
  - setSeverity
```
public void setSeverity(Integer severity)
```
  - drawMode
```
public INParam drawMode(Integer drawMode)
```
  - getDrawMode
```
@Nullable
public Integer getDrawMode()
```
    The draw mode that will be used for the creating the media. * _0_ - will draw nothing, * _1_ - will draw a frame with class name surrounding the object, * _2_ - will draw a filled rectangle that will mask the object, * _3_ - is a combination between _1_ and _2_ (frame/name + mask), * _6_ - will blur the object and * _7_ - is a combination between _1_ and _6_ (frame/name + blur). minimum: 0 maximum: 7
    
    Returns:
    
    drawMode
  - setDrawMode
```
public void setDrawMode(Integer drawMode)
```
  - grey
```
public INParam grey(Integer grey)
```
  - getGrey
```
@Nullable
public Integer getGrey()
```
    A grey scale color to use for masking. '0' will represent black, while the maximum '255' will be white. minimum: 0 maximum: 255
    
    Returns:
    
    grey
  - setGrey
```
public void setGrey(Integer grey)
```
  - scale
```
public INParam scale(Float scale)
```
  - getScale
```
@Nullable
public Float getScale()
```
    Scale of the draw rectangle around the classification object. Specify a value to increase or decrease the size of the border. minimum: 0.5 maximum: 2.0
    
    Returns:
    
    scale
  - setScale
```
public void setScale(Float scale)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class INParam

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_IN_CLASS

SERIALIZED_NAME_MIN

SERIALIZED_NAME_MAX

SERIALIZED_NAME_SEVERITY

SERIALIZED_NAME_DRAW_MODE

SERIALIZED_NAME_GREY

SERIALIZED_NAME_SCALE

Constructor Detail

INParam

Method Detail

inClass

getInClass

setInClass

min

getMin

setMin

max

getMax

setMax

severity

getSeverity

setSeverity

drawMode

getDrawMode

setDrawMode

grey

getGrey

setGrey

scale

getScale

setScale

equals

hashCode

toString