Skip to main content
Ctrl+K

optika documentation

  • Prime Focus Telescope Tutorial
  • optika
  • GitHub
  • PyPI
  • Prime Focus Telescope Tutorial
  • optika
  • GitHub
  • PyPI

Section Navigation

  • shape
  • direction
  • angles
  • mixins
    • Shaped
    • Printable
    • Plottable
    • Transformable
    • Translatable
    • Pitchable
    • Yawable
    • Rollable
  • vectors
    • AbstractPolarizationVectorArray
    • PolarizationVectorArray
    • AbstractFieldVectorArray
    • FieldVectorArray
    • AbstractPupilVectorArray
    • PupilVectorArray
    • AbstractSceneVectorArray
    • SceneVectorArray
    • AbstractObjectVectorArray
    • ObjectVectorArray
  • targets
    • airforce
  • rays
    • AbstractRayVectorArray
    • RayVectorArray
    • AbstractRayFunctionArray
    • RayFunctionArray
  • propagators
    • propagate_rays
    • accumulate_rays
    • AbstractPropagator
    • AbstractRayPropagator
    • AbstractLightPropagator
  • metrology
    • SlopeErrorParameters
    • RoughnessParameters
  • sags
    • AbstractSag
    • NoSag
    • AbstractSphericalSag
    • SphericalSag
    • CylindricalSag
    • AbstractConicSag
    • ConicSag
    • ParabolicSag
    • ToroidalSag
  • chemicals
    • AbstractChemical
    • Chemical
  • materials
    • snells_law_scalar
    • snells_law
    • multilayer_coefficients
    • multilayer_efficiency
    • layer_absorbance
    • AbstractLayer
    • Layer
    • AbstractLayerSequence
    • LayerSequence
    • PeriodicLayerSequence
    • AbstractMaterial
    • Vacuum
    • AbstractMirror
    • Mirror
    • MeasuredMirror
    • AbstractMultilayerMaterial
    • AbstractMultilayerFilm
    • MultilayerFilm
    • AbstractMultilayerMirror
    • MultilayerMirror
    • AbstractThinFilmFilter
    • ThinFilmFilter
    • profiles
      • AbstractInterfaceProfile
      • ErfInterfaceProfile
      • ExponentialInterfaceProfile
      • LinearInterfaceProfile
      • SinusoidalInterfaceProfile
    • matrices
      • refraction
      • propagation
      • transfer
    • meshes
      • AbstractMesh
      • Mesh
  • apertures
    • AbstractAperture
    • CircularAperture
    • CircularSectorAperture
    • EllipticalAperture
    • AbstractPolygonalAperture
    • PolygonalAperture
    • RectangularAperture
    • AbstractRegularPolygonalAperture
    • RegularPolygonalAperture
    • AbstractOctagonalAperture
    • OctagonalAperture
    • AbstractIsoscelesTrapezoidalAperture
    • IsoscelesTrapezoidalAperture
  • rulings
    • incident_effective
    • AbstractRulingSpacing
    • ConstantRulingSpacing
    • Polynomial1dRulingSpacing
    • HolographicRulingSpacing
    • AbstractRulings
    • Rulings
    • MeasuredRulings
    • SinusoidalRulings
    • SquareRulings
    • SawtoothRulings
    • TriangularRulings
    • RectangularRulings
  • surfaces
    • AbstractSurface
    • Surface
  • sensors
    • charge_diffusion
    • mean_charge_capture
    • kernel_diffusion
    • energy_bandgap
    • energy_pair
    • energy_pair_inf
    • quantum_yield_ideal
    • fano_factor
    • fano_factor_inf
    • transmittance
    • absorbance
    • charge_collection_efficiency
    • quantum_efficiency_effective
    • probability_measurement
    • electrons_measured
    • electrons_measured_approx
    • signal
    • vmr_signal
    • AbstractImagingSensor
    • ImagingSensor
    • materials
      • tektronix_tk512cb
      • e2v_ccd203
      • e2v_ccd97
      • AbstractSensorMaterial
      • IdealSensorMaterial
      • AbstractSiliconSensorMaterial
      • AbstractBackIlluminatedSiliconSensorMaterial
      • BackIlluminatedSiliconSensorMaterial
      • depletion
        • e2v_ccd64_thick
        • e2v_ccd64_thin
        • AbstractDepletionModel
        • JanesickDepletionModel
  • distortion
    • AbstractDistortionModel
    • AbstractLinearDistortionModel
    • SimpleDistortionModel
    • AbstractInterpolatedDistortionModel
    • PolynomialDistortionModel
  • radiometry
    • AbstractEffectiveAreaModel
    • InterpolatedEffectiveAreaModel
    • AbstractVignettingModel
    • AbstractInterpolatedVignettingModel
    • PolynomialVignettingModel
  • systems
    • AbstractSystem
    • AbstractSequentialSystem
    • SequentialSystem
  • optika
  • shape

shape#

optika.shape(a)[source]#

Return the array shape of the given object.

If the given object is an instance of named_arrays.AbstractArray, named_arrays.transformations.AbstractTransformation, or optika.mixins.Shaped, a.shape will be returned. Otherwise an empty dictionary will be returned.

Parameters:

a (Any) – The object to find the shape of.

Return type:

dict[str, int]

previous

optika

next

direction

On this page
  • shape()
Show Source

© Copyright 2025, Roy T. Smart and Charles C. Kankelborg.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.