Interface ZOSAPI::Editors::NCE::IObjectDetectorRectangle

Definition:

Usage (see Example 17 for a full sample)

C#

            //Detector Rectangle
            IObjectTypeSettings oType_3 = Object_3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle);
            Object_3.RefObject = 2;
            Object_3.ZPosition = 42;
            Object_3.Material = "ABSORB";
            Object_3.ChangeType(oType_3);
            IObjectDetectorRectangle DetRect3_data = Object_3.ObjectData as IObjectDetectorRectangle;
            DetRect3_data.XHalfWidth = 15;
            DetRect3_data.YHalfWidth = 15;
            DetRect3_data.NumberXPixels = 25;
            DetRect3_data.NumberYPixels = 25;
            DetRect3_data.DataType = 0;
            DetRect3_data.Color = 2;
            DetRect3_data.Smoothing = 1;

C++

    //Detector Rectangle
    IObjectTypeSettingsPtr oType_3 = Object_3->GetObjectTypeSettings(ObjectType_DetectorRectangle);
    Object_3->RefObject = 2;
    Object_3->ZPosition = 42;
    Object_3->Material = "ABSORB";
    Object_3->ChangeType(oType_3);
    IObjectDetectorRectanglePtr DetRect3_data = Object_3->ObjectData;
    DetRect3_data->XHalfWidth = 15;
    DetRect3_data->YHalfWidth = 15;
    DetRect3_data->NumberXPixels = 25;
    DetRect3_data->NumberYPixels = 25;
    DetRect3_data->DataType = 0;
    DetRect3_data->Color = 2;
    DetRect3_data->Smoothing = 1;

Matlab

    % Detector Rectangle
    oType_3 = Object_3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle);
    Object_3.RefObject = 2;
    Object_3.ZPosition = 42;
    Object_3.Material = 'ABSORB';
    Object_3.ChangeType(oType_3);
    DetRect3_data = Object_3.ObjectData;
    DetRect3_data.XHalfWidth = 15;
    DetRect3_data.YHalfWidth = 15;
    DetRect3_data.NumberXPixels = 25;
    DetRect3_data.NumberYPixels = 25;
    DetRect3_data.DataType = 0;
    DetRect3_data.Color = 2;
    DetRect3_data.Smoothing = 1;

Python

    # Detector Rectangle
    oType_3 = Object_3.GetObjectTypeSettings(ZOSAPI.Editors.NCE.ObjectType.DetectorRectangle)
    Object_3.RefObject = 2
    Object_3.ZPosition = 42
    Object_3.Material = "ABSORB"
    Object_3.ChangeType(oType_3)
    DetRect3_data = Object_3.ObjectData
    DetRect3_data.XHalfWidth = 15
    DetRect3_data.YHalfWidth = 15
    DetRect3_data.NumberXPixels = 25
    DetRect3_data.NumberYPixels = 25
    DetRect3_data.DataType = 0
    DetRect3_data.Color = 2
    DetRect3_data.Smoothing = 1

Inherits from:

• ZOSAPI.Editors.NCE.IObject

Members

• Color
• ColorCell
• DataType
• DataTypeCell
• FrontOnly
• FrontOnlyCell
• Id
• IsValid
• Mirroring
• MirroringCell
• NumberXPixels
• NumberXPixelsCell
• NumberYPixels
• NumberYPixelsCell
• PlotScale
• PlotScaleCell
• Polarization
• PolarizationCell
• PsfWaveNumber
• PsfWaveNumberCell
• Row
• Scale
• ScaleCell
• Smoothing
• SmoothingCell
• Type
• XAngleMax
• XAngleMaxCell
• XAngleMin
• XAngleMinCell
• XHalfWidth
• XHalfWidthCell
• YAngleMax
• YAngleMaxCell
• YAngleMin
• YAngleMinCell
• YHalfWidth
• YHalfWidthCell

Properties

Property XHalfWidthCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.XHalfWidthCell

Return type: IEditorCell

Property YHalfWidthCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.YHalfWidthCell

Return type: IEditorCell

Property NumberXPixelsCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.NumberXPixelsCell

Return type: IEditorCell

Property NumberYPixelsCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.NumberYPixelsCell

Return type: IEditorCell

Property DataTypeCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.DataTypeCell

Return type: IEditorCell

Property ColorCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.ColorCell

Return type: IEditorCell

Property SmoothingCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.SmoothingCell

Return type: IEditorCell

Property ScaleCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.ScaleCell

Return type: IEditorCell

Property PlotScaleCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.PlotScaleCell

Return type: IEditorCell

Property FrontOnlyCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.FrontOnlyCell

Return type: IEditorCell

Property PsfWaveNumberCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.PsfWaveNumberCell

Return type: IEditorCell

Property XAngleMinCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.XAngleMinCell

Return type: IEditorCell

Property XAngleMaxCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.XAngleMaxCell

Return type: IEditorCell

Property YAngleMinCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.YAngleMinCell

Return type: IEditorCell

Property YAngleMaxCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.YAngleMaxCell

Return type: IEditorCell

Property PolarizationCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.PolarizationCell

Return type: IEditorCell

Property MirroringCell

Definition:

IEditorCell ZOSAPI.Editors.NCE.IObjectDetectorRectangle.MirroringCell

Return type: IEditorCell

Property XHalfWidth

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.XHalfWidth

Usage (see Example 06 for a full sample)

C#

            // modify object's cell values in the NCE
            ((IObjectSources)o1.ObjectData).NumberOfAnalysisRays = (int)1e6;
            ((IObjectSources)o1.ObjectData).NumberOfLayoutRays = 10;
            ((IObjectSourcePoint)o1.ObjectData).ConeAngle = 2.5;

            o2.ZPosition = 1;
            ((IObjectDetectorRectangle)o2.ObjectData).XHalfWidth = 0.1;
            ((IObjectDetectorRectangle)o2.ObjectData).YHalfWidth = 0.1;
            ((IObjectDetectorRectangle)o2.ObjectData).NumberXPixels = 100;
            ((IObjectDetectorRectangle)o2.ObjectData).NumberYPixels = 100;

C++

    // modify object's cell values in the NCE
    ((IObjectSourcesPtr)o1->ObjectData)->NumberOfAnalysisRays = (int)1e6;
    ((IObjectSourcesPtr)o1->ObjectData)->NumberOfLayoutRays = 10;
    ((IObjectSourcePointPtr)o1->ObjectData)->ConeAngle = 2.5;

    o2->ZPosition = 1;
    ((IObjectDetectorRectanglePtr)o2->ObjectData)->XHalfWidth = 0.1;
    ((IObjectDetectorRectanglePtr)o2->ObjectData)->YHalfWidth = 0.1;
    ((IObjectDetectorRectanglePtr)o2->ObjectData)->NumberXPixels = 100;
    ((IObjectDetectorRectanglePtr)o2->ObjectData)->NumberYPixels = 100;

Matlab

    % modify object's cell values in the NCE
    o1.ObjectData.NumberOfAnalysisRays = 1e6;
    o1.ObjectData.NumberOfLayoutRays = 10;
    o1.ObjectData.ConeAngle = 2.5;
    
    o2.ZPosition = 1;
    o2.ObjectData.XHalfWidth = 0.1;
    o2.ObjectData.YHalfWidth = 0.1;
    o2.ObjectData.NumberXPixels = 100;
    o2.ObjectData.NumberYPixels = 100;

Python

    # modify object's cell values in the NCE
    o1.ObjectData.NumberOfAnalysisRays = 1e6
    o1.ObjectData.NumberOfLayoutRays = 10
    o1.ObjectData.ConeAngle = 2.5

    o2.ZPosition = 1
    o2.ObjectData.XHalfWidth = 0.1
    o2.ObjectData.YHalfWidth = 0.1
    o2.ObjectData.NumberXPixels = 100
    o2.ObjectData.NumberYPixels = 100

Return type: double

Property YHalfWidth

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.YHalfWidth

Return type: double

Property NumberXPixels

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.NumberXPixels

Return type: int

Property NumberYPixels

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.NumberYPixels

Return type: int

Property DataType

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.DataType

Return type: int

Property Color

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.Color

Return type: int

Property Smoothing

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.Smoothing

Return type: int

Property Scale

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.Scale

Return type: int

Property PlotScale

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.PlotScale

Return type: double

Property FrontOnly

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.FrontOnly

Return type: int

Property PsfWaveNumber

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.PsfWaveNumber

Return type: int

Property XAngleMin

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.XAngleMin

Return type: double

Property XAngleMax

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.XAngleMax

Return type: double

Property YAngleMin

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.YAngleMin

Return type: double

Property YAngleMax

Definition:

double ZOSAPI.Editors.NCE.IObjectDetectorRectangle.YAngleMax

Return type: double

Property Polarization

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.Polarization

Return type: int

Property Mirroring

Definition:

int ZOSAPI.Editors.NCE.IObjectDetectorRectangle.Mirroring

Return type: int