Screen1D¶
- class screens.screen.Screen1D(normal, p=<Quantity 0. AU>, v=<Quantity 0. km / s>, magnification=1.0, *, dp_dalpha=<Quantity 0. AU / mas>, source=None, distance=None)[source] [edit on github]¶
Bases:
ScreenOne-dimensional screen.
The assumption is that all scattering points are on lines, which represent places where light can be bent perpendicular to the line, such that it reaches the observer. The positions of the scattering ponts along the lines then depends on where the source and detector are.
- Parameters:
- normal
CartesianRepresentation Unit vector towards the line. Should not include a z component, i.e., be perpendicular to both the line and the z axis.
- p
Quantity Separations of the lines from the origin, along the normal.
- v
Quantity Velocities of the lines along the normal.
- magnificationarray-like
Magnification of scattering points for the lines. Can be complex.
- source
SourceorScreen, optional Possible source illuminating this screen. Unless specific broadcasting is required, it is recommended to use the
Screen.observemethod.- distance
Quantity, optional Possible distance from the source. Only useful if
sourceis given.
- normal
Attributes Summary
Return an instance with the data transposed.
Brightness of each path.
The number of dimensions of the instance and underlying arrays.
The shape of the underlying data.
The size of the object, as calculated from its shape.
Delay for each path.
Time derivative of the delay for each path.
Methods Summary
copy(*args, **kwargs)Return an instance containing copies of the internal data.
diagonal(*args, **kwargs)Return an instance with the specified diagonals.
flatten(*args, **kwargs)Return a copy with the array collapsed into one dimension.
observe(source, distance)ravel(*args, **kwargs)Return an instance with the array collapsed into one dimension.
reshape(*args, **kwargs)Returns an instance containing the same data with a new shape.
squeeze(*args, **kwargs)Return an instance with single-dimensional shape entries removed.
swapaxes(*args, **kwargs)Return an instance with the given axes interchanged.
take(indices[, axis, out, mode])Return a new instance formed from the elements at the given indices.
transpose(*args, **kwargs)Return an instance with the data transposed.
Attributes Documentation
- T¶
Return an instance with the data transposed.
Parameters are as for
T. All internal data are views of the data of the original.
- brightness¶
Brightness of each path.
- isscalar¶
- ndim¶
The number of dimensions of the instance and underlying arrays.
- shape¶
- size¶
The size of the object, as calculated from its shape.
- tau¶
Delay for each path.
- taudot¶
Time derivative of the delay for each path.
Methods Documentation
- copy(*args, **kwargs) [edit on github]¶
Return an instance containing copies of the internal data.
Parameters are as for
copy().
- diagonal(*args, **kwargs) [edit on github]¶
Return an instance with the specified diagonals.
Parameters are as for
diagonal(). All internal data are views of the data of the original.
- flatten(*args, **kwargs) [edit on github]¶
Return a copy with the array collapsed into one dimension.
Parameters are as for
flatten().
- observe(source, distance) [edit on github]¶
- ravel(*args, **kwargs) [edit on github]¶
Return an instance with the array collapsed into one dimension.
Parameters are as for
ravel(). Note that it is not always possible to unravel an array without copying the data. If you want an error to be raise if the data is copied, you should should assign shape(-1,)to the shape attribute.
- reshape(*args, **kwargs) [edit on github]¶
Returns an instance containing the same data with a new shape.
Parameters are as for
reshape(). Note that it is not always possible to change the shape of an array without copying the data (seereshape()documentation). If you want an error to be raise if the data is copied, you should assign the new shape to the shape attribute (note: this may not be implemented for all classes usingNDArrayShapeMethods).
- squeeze(*args, **kwargs) [edit on github]¶
Return an instance with single-dimensional shape entries removed.
Parameters are as for
squeeze(). All internal data are views of the data of the original.
- swapaxes(*args, **kwargs) [edit on github]¶
Return an instance with the given axes interchanged.
Parameters are as for
swapaxes():axis1, axis2. All internal data are views of the data of the original.
- take(indices, axis=None, out=None, mode='raise') [edit on github]¶
Return a new instance formed from the elements at the given indices.
Parameters are as for
take(), except that, obviously, no output array can be given.
- transpose(*args, **kwargs) [edit on github]¶
Return an instance with the data transposed.
Parameters are as for
transpose(). All internal data are views of the data of the original.