unproject_coordinatesT_unproject_coordinatesUnprojectCoordinatesUnprojectCoordinatesunproject_coordinates (Operator)
Name
unproject_coordinatesT_unproject_coordinatesUnprojectCoordinatesUnprojectCoordinatesunproject_coordinates — Calculates image coordinates for a point in a 3D plot window.
Signature
void UnprojectCoordinates(const HObject& Image, const HTuple& WindowHandle, const HTuple& Row, const HTuple& Column, HTuple* ImageRow, HTuple* ImageColumn, HTuple* Height)
void HImage::UnprojectCoordinates(const HWindow& WindowHandle, const HTuple& Row, const HTuple& Column, Hlong* ImageRow, Hlong* ImageColumn, HTuple* Height) const
void HImage::UnprojectCoordinates(const HWindow& WindowHandle, double Row, double Column, Hlong* ImageRow, Hlong* ImageColumn, Hlong* Height) const
void HWindow::UnprojectCoordinates(const HImage& Image, const HTuple& Row, const HTuple& Column, Hlong* ImageRow, Hlong* ImageColumn, HTuple* Height) const
void HWindow::UnprojectCoordinates(const HImage& Image, double Row, double Column, Hlong* ImageRow, Hlong* ImageColumn, Hlong* Height) const
static void HOperatorSet.UnprojectCoordinates(HObject image, HTuple windowHandle, HTuple row, HTuple column, out HTuple imageRow, out HTuple imageColumn, out HTuple height)
void HImage.UnprojectCoordinates(HWindow windowHandle, HTuple row, HTuple column, out int imageRow, out int imageColumn, out HTuple height)
void HImage.UnprojectCoordinates(HWindow windowHandle, double row, double column, out int imageRow, out int imageColumn, out int height)
void HWindow.UnprojectCoordinates(HImage image, HTuple row, HTuple column, out int imageRow, out int imageColumn, out HTuple height)
void HWindow.UnprojectCoordinates(HImage image, double row, double column, out int imageRow, out int imageColumn, out int height)
def unproject_coordinates(image: HObject, window_handle: HHandle, row: Union[float, int], column: Union[float, int]) -> Tuple[int, int, Union[int, float]]
Description
If ImageImageImageimageimage is displayed in WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle using a 3D plot
(i.e., '3d_plot'"3d_plot""3d_plot""3d_plot""3d_plot" was set using set_paintset_paintSetPaintSetPaintset_paint),
unproject_coordinatesunproject_coordinatesUnprojectCoordinatesUnprojectCoordinatesunproject_coordinates calculates the image coordinates
ImageRowImageRowImageRowimageRowimage_row, ImageColumnImageColumnImageColumnimageColumnimage_column, and the HeightHeightHeightheightheight for a given
point RowRowRowrowrow,ColumnColumnColumncolumncolumn in window coordinates.
The window coordinates RowRowRowrowrow, ColumnColumnColumncolumncolumn must be provided in
respect to the current image part. As a consequence, this coordinates are
subpixel coordinates. Given the current image part (row1,column1,row2,
column2), the upper left corner corresponds to the coordinates
(row1 - 0.5, col1 - 0.5). Accordingly, the bottom right corner
corresponds to the coordinates (row2 - 0.5, col2 - 0.5). Use
get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixget_mposition_sub_pix or get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix to obtain these
coordinates directly.
One of the window parameters 'save_depth_buffer'"save_depth_buffer""save_depth_buffer""save_depth_buffer""save_depth_buffer" or
'interactive_plot'"interactive_plot""interactive_plot""interactive_plot""interactive_plot" must be set to 'true'"true""true""true""true" using
set_window_paramset_window_paramSetWindowParamSetWindowParamset_window_param. Otherwise, unproject_coordinatesunproject_coordinatesUnprojectCoordinatesUnprojectCoordinatesunproject_coordinates cannot
be used.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ImageImageImageimageimage (input_object) singlechannelimage → objectHImageHObjectHObjectHobject (byte / direction / cyclic / int1 / int2 / uint2 / int4 / real / complex / vector_field)
Displayed image.
WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
RowRowRowrowrow (input_control) integer → HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Row coordinate in the window.
ColumnColumnColumncolumncolumn (input_control) integer → HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Column coordinate in the window.
ImageRowImageRowImageRowimageRowimage_row (output_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Row coordinate in the image.
ImageColumnImageColumnImageColumnimageColumnimage_column (output_control) integer → HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Column coordinate in the image.
HeightHeightHeightheightheight (output_control) real → HTupleUnion[int, float]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Height value.
Possible Predecessors
get_mbutton_sub_pixget_mbutton_sub_pixGetMbuttonSubPixGetMbuttonSubPixget_mbutton_sub_pix,
get_mposition_sub_pixget_mposition_sub_pixGetMpositionSubPixGetMpositionSubPixget_mposition_sub_pix,
disp_imagedisp_imageDispImageDispImagedisp_image
See also
disp_objdisp_objDispObjDispObjdisp_obj,
update_window_poseupdate_window_poseUpdateWindowPoseUpdateWindowPoseupdate_window_pose,
set_paintset_paintSetPaintSetPaintset_paint
Module
Foundation