componentlist.is_physical

Description The is_physical function is used to check if the specified components meet a number of criteria that must be true if the component could be used to model a physical process. These criteria are:

I > = $\sqrt{Q^2 + U^2 + V^2}$
That the flux, when represented using the Stokes representation, has a zero imaginary value.

The ``Flux properties'' section of the ComponentModels module documentation describes how it is possible to generate a component which has non-zero imaginary value in the Stokes representation.

It is possible to check a number of components at once by specifying the indicies of all the components. The returned value will only be True if all the specified components are physical.

Arguments

`which`	A vector of indices
	`Allowed:`	`Indices must be between 1 and the list length`
	`Default:`	`no default`

Returns nothing

Example

      include 'componentlist.g'
      cl := emptycomponentlist();
      cl.simulate(2);
      cl.setflux(1, [10, 1+3i, 1-4i, 0]print cl.is_physical(1:2), polarization='linear');
      print cl.is_physical(1:2)

This example creates a non-physical component hence the print statement will return F.

Next: componentlist.sample - Function Up: componentlist - Tool Previous: componentlist.sort - Function Contents Index

	`Package`	`synthesis`
	`Module`	`componentmodels`
	`Tool`	`componentlist`

componentlist.is_physical - Function