EikonalWorks User's Manual
  • Workbench
  • IntensityView
  • Core Calculations
Search Results for

    Show / Hide Table of Contents
    • Overview and Client Examples
    • Complete Agent Reference
    • File Input and Output
      • OpenFile
      • SaveFile
      • RemoveLid
    • Queries
      • GetParameter
      • GetProperty
      • GetPropertyField
    • Properties and Flux
      • SetProperty
      • SetLuminousFlux
      • SetLampFlux
      • SetLampNumber
      • SetInputPower
      • SetEmitterLOR
      • SetPhotometryUnit
    • Photometric Transforms
      • SetSymmetryData
      • SetResolution
      • RotateEuler
      • RotateQuaternion
      • Scale
      • AutoAlignPhotometry
      • Smoothen
    • Geometry
      • SetGeometry
    • Luminaire and Channel Management
      • ConfigureLuminaire
      • DuplicateLuminaire
      • MoveMesh
      • RemoveMesh
      • Combine
    • Map Modification
      • PaintBrush
      • FillSelection
      • ScaleAdd
      • CloneTool
      • ApplyTransform
    • Roadway Scenarios
      • LoadRoadwayScenarioFile
      • SaveRoadwayScenarioFile
    • View
      • SetCoordinateSystem
    • Session and History
      • Undo
      • Redo
      • StartCommandServer
      • StopCommandServer

    GetParameter

    Read calculated or descriptive parameters of intensity models.

    Undo support: Not registered as an undoable operation.

    Syntax

    GetParameter <parameter> <emitterId> [<emitterId> ...]
    

    Parameters

    Common names: flux or luminousflux, lampflux, resolution, symmetry, photometrytype or photometry, intensitymaximum or imax, inputpower or power. Names are normalized case-insensitively with punctuation removed. Registered quick-metric IDs and labels are also accepted.

    Example

    GetParameter flux 12
    

    Example IDs are placeholders; replace them with IDs from your current session.

    Response

    Values are space-separated; an invalid ID or unknown parameter returns an error. Unavailable numeric metrics can return N/A.

    Notes

    lampflux means total lamp luminous flux. resolution is N/M; symmetry can contain text; photometry is Type-A, Type-B, Type-C or HEALPix. Request one ID at a time when parsing values with spaces.

    Implementation: EikonalWorksTools/EWIntensityView/src/actions/ui/GetParameterAction.h.

    See API connection, grammar and client examples for quoting, error handling and model IDs.

    In this article
    Back to top Generated by DocFX