Skip to main content
Ctrl+K
Logo image

Site Navigation

  • User Guide
  • API Documentation
  • Quick Parameter Reference
  • Equation Reference
  • Contributing

Site Navigation

  • User Guide
  • API Documentation
  • Quick Parameter Reference
  • Equation Reference
  • Contributing

Section Navigation

  • cavcalc
    • cavcalc.calculate
      • cavcalc.calculate.calculate
    • cavcalc.env
      • cavcalc.env.configure
    • cavcalc.errors
      • cavcalc.errors.CavCalcError
    • cavcalc.functions
      • cavcalc.functions.asymmetric
        • cavcalc.functions.asymmetric.Rc1_of_g1
        • cavcalc.functions.asymmetric.Rc2_of_g2
        • cavcalc.functions.asymmetric.divang_of_g1g2
        • cavcalc.functions.asymmetric.g1_of_Rc1
        • cavcalc.functions.asymmetric.g1_of_w1w2
        • cavcalc.functions.asymmetric.g2_of_Rc2
        • cavcalc.functions.asymmetric.g2_of_w1w2
        • cavcalc.functions.asymmetric.g_of_g1g2
        • cavcalc.functions.asymmetric.modesep_of_g1g2
        • cavcalc.functions.asymmetric.rtgouy_of_g1g2
        • cavcalc.functions.asymmetric.w0_of_g1g2
        • cavcalc.functions.asymmetric.w1_of_g1g2
        • cavcalc.functions.asymmetric.w2_of_g1g2
        • cavcalc.functions.asymmetric.z0_of_g1g2
      • cavcalc.functions.resonance
        • cavcalc.functions.resonance.Aext_of_R1R2
        • cavcalc.functions.resonance.Aint_of_R1R2
        • cavcalc.functions.resonance.Atrn_of_R1R2
        • cavcalc.functions.resonance.R1_of_T1L1
        • cavcalc.functions.resonance.R2_of_T2L2
        • cavcalc.functions.resonance.T1_of_R1L1
        • cavcalc.functions.resonance.T2_of_R2L2
        • cavcalc.functions.resonance.finesse
        • cavcalc.functions.resonance.fsr
        • cavcalc.functions.resonance.fwhm
        • cavcalc.functions.resonance.pole
      • cavcalc.functions.symmetric
        • cavcalc.functions.symmetric.divang_of_gsingle
        • cavcalc.functions.symmetric.gcav_of_gsingle
        • cavcalc.functions.symmetric.gsingle_of_divang
        • cavcalc.functions.symmetric.gsingle_of_gcav
        • cavcalc.functions.symmetric.gsingle_of_roc
        • cavcalc.functions.symmetric.gsingle_of_rtgouy
        • cavcalc.functions.symmetric.gsingle_of_w
        • cavcalc.functions.symmetric.modesep_of_gsingle
        • cavcalc.functions.symmetric.roc_of_gsingle
        • cavcalc.functions.symmetric.rtgouy_of_gsingle
        • cavcalc.functions.symmetric.w0_of_gsingle
        • cavcalc.functions.symmetric.w_of_gsingle
        • cavcalc.functions.symmetric.z0_symmetric
    • cavcalc.output
      • cavcalc.output.BaseOutput
        • cavcalc.output.BaseOutput.given
        • cavcalc.output.BaseOutput.__init__
        • cavcalc.output.BaseOutput.print
        • cavcalc.output.BaseOutput.save
      • cavcalc.output.MultiOutput
        • cavcalc.output.MultiOutput.results
        • cavcalc.output.MultiOutput.__init__
        • cavcalc.output.MultiOutput.as_single
        • cavcalc.output.MultiOutput.as_singles
        • cavcalc.output.MultiOutput.get
        • cavcalc.output.MultiOutput.plot
      • cavcalc.output.SingleOutput
        • cavcalc.output.SingleOutput.name
        • cavcalc.output.SingleOutput.result
        • cavcalc.output.SingleOutput.__init__
        • cavcalc.output.SingleOutput.convert
        • cavcalc.output.SingleOutput.plot
      • cavcalc.output.load
    • cavcalc.parameters
      • cavcalc.parameters.enums
        • cavcalc.parameters.enums.ParameterCategory
        • cavcalc.parameters.enums.ParameterType
      • cavcalc.parameters.parameter
        • cavcalc.parameters.parameter.ArgParameter
        • cavcalc.parameters.parameter.Parameter
        • cavcalc.parameters.parameter.TargetParameter
      • cavcalc.parameters.tools
        • cavcalc.parameters.tools.get_default_units
        • cavcalc.parameters.tools.get_name
        • cavcalc.parameters.tools.get_names
        • cavcalc.parameters.tools.get_names_descriptions
        • cavcalc.parameters.tools.get_type
        • cavcalc.parameters.tools.get_valid_arguments
        • cavcalc.parameters.tools.get_valid_targets
  • API Documentation
  • cavcalc.output.MultiOutput
  • cavcalc.output.MultiOutput.as_single

cavcalc.output.MultiOutput.as_single#

MultiOutput.as_single(ptype: Union[str, ParameterType]) → SingleOutput#

A SingleOutput instance constructed, from this multi-output, for a single desired parameter type.

Parameters:
ptypestr | ParameterType

The parameter type.

Returns:
singleSingleOutput

The single output object for the desired parameter type.

previous

cavcalc.output.MultiOutput.__init__

next

cavcalc.output.MultiOutput.as_singles

© Copyright 2019 - 2024, Samuel Rowlinson.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.3.