Class FovParamsConfigs

Namespace

CTRE.Phoenix6.Configs

Assembly

Phoenix6.Hardware.dll

Configs that affect the ToF Field of View

Includes range and center configs

public class FovParamsConfigs : IParentConfiguration, ISerializable, ICloneable

Inheritance

object

FovParamsConfigs

Implements

IParentConfiguration

ISerializable

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Fields

FOVCenterX

Specifies the target center of the Field of View in the X direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value-11.8
• Maximum Value11.8
• Default Value0
• Unitsdeg

public double FOVCenterX

Field Value

double

FOVCenterY

Specifies the target center of the Field of View in the Y direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value-11.8
• Maximum Value11.8
• Default Value0
• Unitsdeg

public double FOVCenterY

Field Value

double

FOVRangeX

Specifies the target range of the Field of View in the X direction. This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterX).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value6.75
• Maximum Value27
• Default Value27
• Unitsdeg

public double FOVRangeX

Field Value

double

FOVRangeY

Specifies the target range of the Field of View in the Y direction. This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterY).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value6.75
• Maximum Value27
• Default Value27
• Unitsdeg

public double FOVRangeY

Field Value

double

Methods

Clone()

Creates a copy of this config group.

public FovParamsConfigs Clone()

Returns

FovParamsConfigs

Deserialize(string)

Deserialize string and put values into this object

public StatusCode Deserialize(string to_deserialize)

Parameters

to_deserialize string

String to deserialize

Returns

StatusCode

OK if deserialization is OK

Serialize()

Serialize this object into a string

public string Serialize()

Returns

string

This object's data serialized into a string

ToString()

Provides the string representation of this object

public override string ToString()

Returns

string

WithFOVCenterX(double)

Modifies this configuration's FOVCenterX parameter and returns itself for method-chaining and easier to use config API.

Specifies the target center of the Field of View in the X direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value-11.8
• Maximum Value11.8
• Default Value0
• Unitsdeg

public FovParamsConfigs WithFOVCenterX(double newFOVCenterX)

Parameters

newFOVCenterX double

Parameter to modify

Returns

FovParamsConfigs

Itself

WithFOVCenterY(double)

Modifies this configuration's FOVCenterY parameter and returns itself for method-chaining and easier to use config API.

Specifies the target center of the Field of View in the Y direction.

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value-11.8
• Maximum Value11.8
• Default Value0
• Unitsdeg

public FovParamsConfigs WithFOVCenterY(double newFOVCenterY)

Parameters

newFOVCenterY double

Parameter to modify

Returns

FovParamsConfigs

Itself

WithFOVRangeX(double)

Modifies this configuration's FOVRangeX parameter and returns itself for method-chaining and easier to use config API.

Specifies the target range of the Field of View in the X direction. This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterX).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value6.75
• Maximum Value27
• Default Value27
• Unitsdeg

public FovParamsConfigs WithFOVRangeX(double newFOVRangeX)

Parameters

newFOVRangeX double

Parameter to modify

Returns

FovParamsConfigs

Itself

WithFOVRangeY(double)

Modifies this configuration's FOVRangeY parameter and returns itself for method-chaining and easier to use config API.

Specifies the target range of the Field of View in the Y direction. This is the full range of the FOV.

The magnitude of this is capped to abs(27 - 2*FOVCenterY).

The exact value may be different for different CANrange devices due to imperfections in the sensing silicon.

• Minimum Value6.75
• Maximum Value27
• Default Value27
• Unitsdeg

public FovParamsConfigs WithFOVRangeY(double newFOVRangeY)

Parameters

newFOVRangeY double

Parameter to modify

Returns

FovParamsConfigs

Itself