get_partT_get_partGetPartGetPartget_part (Operator)
Name
get_partT_get_partGetPartGetPartget_part — Get the image part.
Signature
void GetPart(const HTuple& WindowHandle, HTuple* Row1, HTuple* Column1, HTuple* Row2, HTuple* Column2)
void HWindow::GetPart(HTuple* Row1, HTuple* Column1, HTuple* Row2, HTuple* Column2) const
void HWindow::GetPart(Hlong* Row1, Hlong* Column1, Hlong* Row2, Hlong* Column2) const
static void HOperatorSet.GetPart(HTuple windowHandle, out HTuple row1, out HTuple column1, out HTuple row2, out HTuple column2)
void HWindow.GetPart(out HTuple row1, out HTuple column1, out HTuple row2, out HTuple column2)
void HWindow.GetPart(out int row1, out int column1, out int row2, out int column2)
def get_part(window_handle: HHandle) -> Tuple[Union[int, float], Union[int, float], Union[int, float], Union[int, float]]
Description
get_partget_partGetPartGetPartGetPartget_part returns the upper left and lower right corner
of the image part shown in the window. The image part can be
changed with the operator set_partset_partSetPartSetPartSetPartset_part (Default is the
whole image).
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
WindowHandleWindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control) window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Window handle.
Row1Row1Row1Row1row1row_1 (output_control) rectangle.origin.y → HTupleUnion[int, float]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Row index of the image part's upper left corner.
Column1Column1Column1Column1column1column_1 (output_control) rectangle.origin.x → HTupleUnion[int, float]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Column index of the image part's upper left corner.
Row2Row2Row2Row2row2row_2 (output_control) rectangle.corner.y → HTupleUnion[int, float]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Row index of the image part's lower right corner.
Column2Column2Column2Column2column2column_2 (output_control) rectangle.corner.x → HTupleUnion[int, float]HTupleHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double)
Column index of the image part's lower right corner.
Result
get_partget_partGetPartGetPartGetPartget_part returns 2 (
H_MSG_TRUE)
if the window is valid.
Otherwise an exception is raised.
Possible Successors
set_partset_partSetPartSetPartSetPartset_part,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region,
disp_imagedisp_imageDispImageDispImageDispImagedisp_image
See also
set_partset_partSetPartSetPartSetPartset_part,
disp_imagedisp_imageDispImageDispImageDispImagedisp_image,
disp_regiondisp_regionDispRegionDispRegionDispRegiondisp_region,
disp_colordisp_colorDispColorDispColorDispColordisp_color
Module
Foundation