Function: LiEmissionSetEnquire

LiEmissionSetEnquire

Function

LtStatus

LiEmissionSetEnquire(	`LtEmissionSet`	the_set
	`LtNat32*`	num_thetas
	`LtFloat*`	thetas[]
	`LtNat32*`	num_phis
	`LtFloat*`	phis[]
	`LtFloat*`	data[]
	`LtBitfield*`	extras
	)

Synopsis Enquire the current contents of an emission set.

Location lishpro

Parameters

`the_set`	Emission set being enquired about.
`num_thetas`	The number of theta angles in the data.
`thetas[]`	Array of theta angles.
`num_phis`	The number of phi angles in the data.
`phis[]`	Array of phi angles.
`data[]`	The emission set data.
`extras`	Any additional information.

Return Value

A status value.

Description This routine provides handles to the arrays being used internally by the emission set. It allows all values currently being used by the emission set to be accessed. This could be useful in cases such as those where LiEmissionSetPreProcess has been called potentially changing the definition of the emission set from that originally passed to LiEmissionSetCreate. Attempts to enquire into a NULL emission set will result in an error status being returned.

Example


LtEmissionSet  the_set = (LtEmissionSet)NULL ;
LtStatus       status = LI_STATUS_OK ;
LtNat32        num_thetas ,
               num_phis ;
LtFloat       *thetas ,
              *phis ,
              *data ;
LtBitfield     extras ;

/*
 * Create an emission set using LiEmissionSetCreate
 * then pre-process it and enquire what its new
 * parameters are.
 */

...

if ( the_set != (LtEmissionSet)NULL )
{
   status = LiEmissionSetPreProcess( the_set ) ;
   if ( LiStatusOk( status ) )
      status = LiEmissionSetEnquire( the_set, 
                                     &num_thetas, &thetas, 
                                     &num_phis, &phis, &data, 
                                     &extras ) ;
}

See Also LiEmissionSetCopy
LiEmissionSetCreate
LiEmissionSetDebug
LiEmissionSetDestroy
LiEmissionSetPreProcess
LiEmissionSetRead
LiEmissionSetWrite